Créer un nouveau widget dans le dashboard WordPress

Ajouter un nouveau widget personnalisé dans le tableau de bord WordPress est chose facile. Une fonction d’appel lié à un hook et une autre fonction pour générer le contenu : votre dashboard affiche ensuite un contenu unique en quelques lignes de code, transformant l’interface initiale WordPress en un tableau de bord personnalisé pour vos clients.

Découvrez comment utiliser la fonction WordPress wp_add_dashboard_widget dans ce tutoriel vidéo.

• Fonction WordPress wp_add_dashboard_widget : codex.wordpress.org
• Code créé dans ce tutoriel : http://pastebin.com/XUeBE02q

Vous ne le savez peut-être pas, mais créer des widgets personnalisés pour personnaliser le tableau de bord d’administration WordPress est relativement simple. Cela vous donne la possibilité d’afficher des résumés, statistiques, derniers contenus ou autres outils rapides propres au site créé, transformant l’administration par défaut de WordPress en une page un peu plus personnelle.

Utilisation de wp_add_dashboard_widget

function custom_dashboard_contact_widget(){
 wp_add_dashboard_widget($widget_id, $widget_name, $callback, $control_callback );
}
add_action('wp_dashboard_setup', 'custom_dashboard_contact_widget');

function custom_dashboard_contact_widget_content() {
 echo 'Contenu du widget';
}

Qu’est-ce que l’on fait à travers ce code :

1. on créée une fonction custom_dashboard_contact_widget() dans laquelle on utilise wp_add_dashboard_widget pour enregistrer notre nouveau widget
2. on hooke notre fonction fraîchement créée dans l’action WordPress wp_dashboard_setup, action qui initialise les widgets du tableau de bord d’administration
3. enfin, on écrit la fonction passée en $callback dans wp_add_dashboard_widget. Ici, custom_dashboard_contact_widget_content() sera en charge de générer le contenu qui sera affiché dans notre widget.

Deux fonctions, une action et le tour est joué ! Mais quels sont paramètres utilisés dans wp_add_dashboard_widget ?

• $widget_id est l’identifiant unique du widget, qui servira à :
  
  • modifier la position ou supprimer le widget
  • assigner cet identifiant en ID CSS du widget pour pouvoir sélectionner et styliser facilement le widget
• $widget_name est le titre du widget qui sera affiché avant son contenu
• $callback est la fonction PHP qui s’occupera de générer le contenu du widget. Dans la fonction custom_dashboard_contact_widget_content() ci-dessus, on echo un simple texte mais tout est possible : charger des contenus avec des loops WordPress, utiliser des API tierces pour afficher des derniers tweets ou  photos récentes, etc… Faites preuve d’imagination !
• enfin, $control_callback est une fonction qui gèrera, si besoin, l’affichage et le traitement du formulaire de configuration du widget

Pour terminer, sachez que les widgets natifs WordPress sont enregistrés dans le fichier wp-admin/dashboard.php. Il est toujours intéressant de savoir comment le moteur génère le contenu par défaut, n’hésitez pas à y jeter un coup d’oeil pour mieux comprendre l’utilisation de wp_add_dashboard_widget.

Un widget intéressant à partager ? Faites-le nous savoir en commentaire !