Création d’un plugin WordPress : les Widgets
Vous l’aurez surement deviné, dans cet article nous allons aborder le cas des widgets. Les widgets sont des petites fonctions qui s’exécutent sur votre blog et dont le résultat est montré dans la barre latérale (sidebar). Par défaut, plusieurs widgets sont présent sur votre blog : la barre de recherche, les archives, les catégories … Si votre plugin doit s’afficher, au moins en partie, dans la sidebar, vous allez devoir utiliser les widgets. Mais rassurez-vous, il n’y a rien de trop compliqué.
Comme je vous le disais en introduction, de base, votre blog utilise déjà des widgets. Lorsque vous allez tenter d’afficher le widget de votre plugin, vous devrez vous rendre dans le panneau d’administration, puis dans la section Apparence et Widgets. Là, vous allez voir tous les widgets disponibles, y compris ceux de votre plugin, s’ils sont bien déclaré (nous verrons ensuite comment faire). Pour ajouter un widget à votre sidebar, rien de plus simple. Il suffit, en effet, de cliquer sur le bouton ajouter qui se trouve à gauche du widget qui vous intéresse. Une fois fait, le widget va être ajouter dans la liste de droite, et il faudra cliquer sur Enregistrer les modifications.
Le seul léger souci de cette méthode est que les widgets que votre utilisait par défaut ne se trouvent pas dans la liste de droite. Quand vous cliquez sur Enregistrer les modifications, vous vous retrouvez alors avec une sidebar ne contenant plus que le nouveau widget. Les autres ont disparu. Rien de bien grave cependant, pour les récupérer il suffit de les rajouter un à un, via la même interface. Il s’y trouvent tous. Vous pourrez ensuite, dans la liste des widgets à afficher, faire des cliquer-glisser pour choisir l’ordre dans lequel ils doivent s’afficher. Voila le tour est joué. Si vous préférez utiliser le fichier sidebar.php pour gérer vos widget, vous pouvez aussi y inserer le nom de la fonction gérant le widget. Voyons maintenant comment déclarer proprement ses widgets au sein d’un plugin.
Pour déclarer un widget, on va écrire une fonction. Cette fonction aura pour but de calculer ce que le widget doit afficher. Elle va bien évidement dépendre du type de plugin que vous être en train de développer, et c’est pour cette raison que je ne vais pas la détailler ici. Ensuite, vous allez devoir faire appel à une fonction très similaire à celle que nous avons utilisé dans l’article précédent pour déclarer les fonctions d’initialisation du plugin.
register_sidebar_widget('WP FaceThumb', array('WP_FaceThumb', 'display_plugin'));Ici aussi j’utilise un array, mais c’est pour la même raison que dans l’article précédent. Retenez surtout que le premier argument est le nom sous lequel votre widget apparaîtra dans le menu Apparence > Widgets, et le second, le nom de la fonction qui calcule ce que le widget va afficher. Voila le widget est fonctionnel et correctement intégré à votre blog. Son résultat ne dépend maintenant que de la fonction à laquelle il fait appel.