Nous entendons souvent parler de l'API WordPress Dashboard Widgets, mais de quoi s'agit-il exactement ? Découvrez à quoi sert cette API, pourquoi elle est si importante pour votre site WordPress et comment ajouter facilement des widgets à votre tableau de bord. Améliorez les fonctionnalités de votre site.

Qu'est-ce que l'API Dashboard Widgets ?

L'API Dashboard Widgets est un ensemble d'outils fournis par WordPress qui vous permet d'ajouter, de supprimer ou de modifier facilement des widgets sur votre tableau de bord. Elle est parfaite pour ceux qui souhaitent communiquer directement avec leurs utilisateurs, que ce soit pour afficher des informations ou pour les inciter à effectuer certaines actions.

Voici quelques exemples :

• Plugin JetpackIl ajoute un widget au tableau de bord qui vous permet de voir les statistiques de visite du site, ainsi que les articles et les pages les plus populaires.
• La baladodiffusion en toute simplicitéCe plugin est livré avec Seriously Simple Stats, qui vous permet d'afficher les statistiques de votre blog. Il dispose également d'un widget de flux RSS qui affiche les nouvelles de Castos - Castos est la société qui a développé ce plugin de blog.

Ces API et widgets rendent votre tableau de bord WordPress plus puissant et personnalisé, en rendant la présentation des informations et l'interaction avec l'utilisateur plus directes et plus efficaces.

Comment utiliser l'API du widget du tableau de bord

Depuis la version 2.7 de WordPress, l'API Dashboard Widget permet d'ajouter facilement de nouveaux widgets au tableau de bord de l'administrateur de WordPress. Les principales fonctionnalités que vous devez connaître sont les suivanteswp_add_dashboard_widget() fonction. La fonction prend plusieurs arguments :

1. $widget_id- L'identifiant unique de votre widget, qui est également utilisé comme attribut id dans la sortie HTML du widget.
2. $widget_name- Le nom de votre widget
3. $callback- La fonction qui sera appelée pour afficher le contenu du widget. La fonction doit afficher en retour le contenu du widget.

En outre, vous pouvez spécifier certains paramètres facultatifs.

1. $control_callback- Une fonction optionnelle qui sera appelée pour sortir les données que le contrôle a utilisées pour configurer le widget, ainsi que pour traiter toutes les données qui ont été soumises par le contrôle.
2. $callback_args- Tableau de paramètres facultatifs à transmettre à la fonction de rappel
3. $contexte- Une chaîne optionnelle qui définit les colonnes que le widget affichera. La valeur par défaut est "normal", mais d'autres options incluent "side", "column3" et "column4". "
4. $priorité- Une chaîne facultative qui définit la priorité des widgets dans le contexte. La valeur par défaut est "core", mais les autres options incluent "default", "high" et "low".

Pour comprendre comment cela fonctionne, construisons un exemple de widget de tableau de bord

Ajouter un widget de tableau de bord

Configuration initiale et sortie

Tout d'abord, créez un nouveau répertoire de plugins et des fichiers PHP de plugins dans le répertoire wp-content/plugins. Pour cet exemple, vous pouvez l'appelerwp-learn-dashboard-widgets.

Pour que le plugin soit reconnu comme un plugin WordPress, vous devez ajouter un en-tête de plugin qui contient au moins une valeur de nom de plugin.

Comme avec la plupart des API de WordPress, vous allez d'abord accrocher une action. Dans ce cas, utilisez l'optionwp_dashboard_setup gréementCette action est déclenchée lorsque le tableau de bord est initialisé. Vous ajouterez notre widget ici.

add_action( 'wp_dashboard_setup', 'wp_learn_dashboard_widget' ) ;
function wp_learn_dashboard_widget(){
    wp_add_dashboard_widget(
        'wp_learn_dashboard_widget',
        'Widget de tableau de bord d'apprentissage de WordPress'.
        'wp_learn_dashboard_widget_callback'
    ) ;
}

function wp_learn_dashboard_widget_callback(){
    echo '<p>Bonjour à tous !</p>';
}

Si vous ajoutez ce code à un fichier plugin vide, activez le plugin et chargez le tableau de bord, vous verrez votre widget au bas de la première colonne du tableau de bord.

Votre fonction de rappel de contenu est très flexible, tant qu'elle rappelle du HTML valide.

wp_get_recent_posts() Essayer d'utiliser les fonctionsAjoutez une liste des derniers articles à votre widget.

function wp_learn_dashboard_widget_callback(){
    $args = array(
        'numberposts' => 5, 'post_status' => 'publish', 'post_status' => 'publish')
        'post_status' => 'publish'
    ) ;
    $recent_posts = wp_get_recent_posts( $args ) ;
    echo '<ul>' ;
    foreach( $recent_posts as $recent ){
        echo '<li><a href="/fr/' . get_permalink( $recent['ID'] ) . '/">' . $recent['post_title'] . '</a></li>' ;
    }
    echo '</ul>';
}

Ajout de contrôles de widgets

Vous pouvez également ajouter des contrôles pour configurer votre widget. Supposons que vous souhaitiez contrôler le nombre d'articles affichés. Pour ce faire, configurez la fonction de rappel de contrôle.

Ajouter une fonction à appelerwp_learn_dashboard_widget_control()pour traiter les données.

function wp_learn_dashboard_widget_control(){
    echo 'Enter number of posts to display' ;
    echo '' ; '' ; } ; }.
}

Lorsque vous actualisez le tableau de bord, rien ne semble se passer, mais si vous survolez le widget, vous verrez un nouveau lien qui indique la "Configuration". En cliquant sur ce lien, vous afficherez le formulaire que vous venez de créer.

Vous devez maintenant mettre à jour le callback du contrôle pour gérer les données soumises par le formulaire.

Pour enregistrer les données, utilisez la toucheoption_mise_à_jour() fonction (math.)la fonction enregistre la valeur dans le tableau des options.

function wp_learn_dashboard_widget_control_callback(){
    if (isset($_POST['wp_learn_dashboard_widget_numberposts'])){
        update_option( 'wp_learn_dashboard_widget_numberposts', sanitize_text_field( $_POST['wp_learn_dashboard_widget_numberposts'] ) ); ;
    }
    $number_posts = get_option('wp_learn_dashboard_widget_numberposts', 5 ) ;
    echo 'Enter number of posts to display' ;
    echo '' ; } ; }.
}

Vous devez ensuite retourner à la fonction de rappel du contenu et mettre à jour le tableau$argspour utiliser la valeur que vous venez d'enregistrer. Pour obtenir la valeur, vous pouvez utiliser la fonctionget_option()fonction (math.).

function wp_learn_dashboard_widget_callback(){
    $numberposts = get_option('wp_learn_dashboard_widget_numberposts', 5 ) ;
    $args = array(
        'numberposts' => $numberposts,
        'post_status' => 'publish'
    ) ;
    $recent_posts = wp_get_recent_posts( $args ) ;
    echo '<ul>' ;
    foreach( $recent_posts as $recent ){
        echo '<li><a href="/fr/' . get_permalink( $recent['ID'] ) . '/">' . $recent['post_title'] . '</a></li>' ;
    }
    echo '</ul>';
}

rendre un verdict

Pour plus d'informations sur l'utilisation du widget de tableau de bord, y compris des exemples d'utilisation des paramètres facultatifs de rappel, de contexte et de priorité, consultez la sectionSection de l'API sur les widgets du tableau de bord.