Codage et enregistrement de votre widget WordPress

C'est la deuxième partie d'une série qui vous montre comment créer votre premier widget WordPress. Dans la première partie, vous avez découvert l’API Widgets et la WP_Widget classe. Dans cette partie, vous apprendrez à démarrer le processus de construction de votre widget en créant la classe pour le contenir et en l'enregistrant..

Au complet, cette série comprend cinq parties:

  • 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

Ce dont vous aurez besoin

Pour suivre cette série, vous aurez besoin de:

  • Une installation de développement de WordPress
  • Un éditeur de code

Configurer le plugin

Vous devez d’abord configurer votre plugin. Créez un nouveau fichier dans votre wp-content / plugins annuaire. J'ai appelé le mien tutsplus-list-subpages-widget.php.

Ajoutez ce qui suit au fichier:

Évidemment, vous voudrez changer le nom de l'auteur et l'URL, mais cela donne à WordPress ce dont il a besoin pour afficher le plugin dans l'écran Plugins.

Enregistrez votre fichier de plugin.

Création de la classe de widget

L’étape suivante consiste à créer une nouvelle classe pour étendre la WP_Widget classe.

Tapez ce code dans votre fichier plugin:

Voyons en quoi consiste cette classe:

  • la __construction function fera ce que vous attendez - il construira la fonction. Dans cette fonction, vous définissez des éléments tels que l'ID du widget, son titre et sa description..
  • la forme la fonction créera le formulaire dans l'écran des widgets qui permettra aux utilisateurs de personnaliser ou d'activer le widget.
  • la mettre à jour Cette fonction garantit que WordPress met à jour les paramètres saisis par les utilisateurs dans l'écran Widgets..
  • la widget la fonction définit ce qui est généré par le widget situé à l'avant du site.

Les trois derniers ont des paramètres que je vais expliquer plus en détail dans les tutoriels correspondants..

Enregistrement du widget

Votre widget ne fonctionnera pas si vous ne l'enregistrez pas avec WordPress. Sous votre classe, ajoutez la fonction et le crochet pour le faire:

le register_widget () fonction est une fonction WordPress dont le seul paramètre est le nom de la classe que vous venez de créer.

Vous accrochez ensuite votre fonction au widgets_init crochet pour s'assurer qu'il est ramassé par WordPress.

Remarque: votre widget ne fonctionnera pas encore et ne s'affichera pas sur l'écran Widgets. Ne vous inquiétez donc pas pour l'activation du plugin. Pour que cela fonctionne, vous devrez suivre toutes les étapes de cette série..

Résumé

Vous avez maintenant commencé le processus de construction de votre premier widget WordPress. Vous avez créé un plugin pour le widget, créé une classe pour construire le widget et l'avez enregistré..

Dans le prochain tutoriel, vous apprendrez à construire le widget en utilisant votre __construction une fonction.