Introduction à la création de votre premier widget WordPress

Pour les non-codeurs créant un site WordPress, les widgets sont excellents. Ils vous permettent d'ajouter des menus, des listes, des flux, du texte et bien plus encore à des zones de widgets qui n'ont pas besoin d'être limitées à la barre latérale. De nombreux thèmes comportent désormais des zones de widget dans le pied de page, et les grands frameworks de thème ont souvent des zones de widget dans plusieurs emplacements, tels que l'en-tête et avant et après le contenu..

Dans cette série en cinq parties, je vais vous expliquer les étapes nécessaires à la création de votre premier widget. La série couvrira:

• Introduction aux widgets et à l'API Widgets
• Coder et enregistrer votre widget
• Construire votre widget
• Construire le formulaire pour votre widget
• Affichage de votre widget dans la zone de widget appropriée

Dans cette partie, je présenterai les widgets et l'API Widgets..

Créer des widgets

Pour créer un widget, vous étendez la WP_Widget classe, qui comprend un certain nombre de fonctions:

• une fonction pour traiter le widget
• une fonction permettant d'afficher un formulaire pour le widget dans l'écran du tableau de bord Widgets
• une fonction permettant aux utilisateurs de mettre à jour les paramètres du widget
• une fonction pour afficher le widget dans n'importe quelle zone de widget, il est ajouté à.

En plus de cela, vous utilisez le register_widget () fonction pour enregistrer le widget que vous avez créé.

Vous pouvez insérer à peu près tout ce que vous voulez dans un widget: texte statique, sortie d'une requête de base de données, flux d'un autre site, etc. Cependant, il est important de noter que les utilisateurs s'attendent à ce que les widgets tiennent dans une zone définie de la page. Par conséquent, la sortie de votre widget ne doit pas être trop importante..

WordPress est livré avec un tableau de widgets intégrés, donc avant de commencer à coder les vôtres, vérifiez qu'il n'est pas déjà dans le noyau de WordPress.

Dans cette série, je vais créer un widget à partir d'un plugin que j'ai développé pour un tutoriel précédent, sur la création d'une navigation par barre latérale contextuelle. Dans ce tutoriel, j'ai développé une fonction que les utilisateurs connaissant bien le code pourraient intégrer à leur thème ou joindre à un crochet, mais il leur serait plus facile d'ajouter la navigation via un widget..

L'API Widgets

L'API Widgets inclut les fonctions nécessaires à la création de votre widget. Jetons un coup d'oeil à chacun d'eux.

Premièrement, il y a quatre fonctions de widget:

• is_active_widget (): une balise conditionnelle qui vérifie si un widget individuel est actif. Ne pas confondre avec is_active_sidebar (), qui vérifie si des widgets ont été ajoutés à une zone de widget spécifique.
• the_widget (): une balise de modèle qui affiche un widget en dehors des zones de widget.
• register_widget (): la fonction pour enregistrer un widget, que je vais utiliser plus tard dans cette série.
• unregister_widget (): désenregistre un widget, ce qui signifie qu'il n'est plus disponible pour les utilisateurs via l'écran Widgets.

Il existe également cinq fonctions internes:

• wp_register_widget_control (): crée les contrôles sur l'écran des widgets afin que les utilisateurs puissent modifier les paramètres du widget.
• wp_unregister_widget_control (): enregistre le contrôle de widget qui a été enregistré via wp_register_widget_control ().
• wp_convert_widget_settings (): ceci convertit les paramètres d'un widget sous forme d'instance unique en multi-widget.
• wp_get_widget_defaults (): fonction principale, à ne pas utiliser par les développeurs de plugins ou de thèmes
• wp_widget_description (): crée une description de widget qui sera affichée sur l'écran Widgets.

Pour accéder à ces fonctions internes, vous utiliserez le WP_Widget classe. Ceci est une classe constructeur que vous pouvez étendre pour créer des widgets supplémentaires.

Résumé

 Ce didacticiel d’introduction a heureusement stimulé votre appétit pour la création de vos propres widgets. Dans le prochain tutoriel, je vais vous montrer comment coder votre widget et l'enregistrer..