Développement du plugin WordPress

Si vous avez déjà utilisé WordPress pour créer un site rapidement, il est probable que vous ayez utilisé l'un des nombreux plugins qui sont proposés pour étendre les fonctionnalités de ce logiciel de blogs populaire. Les plugins sont l'une des nombreuses choses qui rendent WordPress si attrayant. Si vous avez besoin d'une galerie d'images ou d'un formulaire de contact, il y a probablement un plugin déjà disponible que vous pouvez télécharger et utiliser. Il y a des moments, cependant, lorsque vous ne pouvez pas vraiment trouver ce dont vous avez besoin des plugins existants. Cet article vous montrera comment créer vos propres plugins WordPress en vous parcourant un exemple pour afficher un texte à l'aide d'un widget dans une barre latérale.

Les plats clés

• Les plugins WordPress, qui étendent les fonctionnalités du logiciel de blog, peuvent être créés par les utilisateurs lorsqu'ils ne trouvent pas un plugin existant qui répond à leurs besoins. Le processus de création consiste à créer un nouveau sous-répertoire dans le répertoire WP-Content / Plugins et à fournir un descripteur dans le fichier PHP Commentaires pour identifier le plugin.
• WordPress fournit une classe WP_Widget qui peut être étendue pour créer des widgets personnalisés. La classe WP_Widget a quatre méthodes qui devraient être remplacées: __Construct (), Form (), Update () et Widget (). Ces méthodes initialisent le widget, affichent un formulaire de personnalisation, mettent à jour les propriétés du widget et affichent le widget sur le blog, respectivement.
• Lors de la création d'un plugin WordPress, il est important de suivre les meilleures pratiques telles que l'utilisation de conventions de dénomination appropriées, d'assurer la sécurité en validant et désinfectant la saisie des utilisateurs et en rendant le plugin traduisible pour atteindre un public plus large. La compatibilité avec tous les thèmes peut être obtenue en adhérant aux normes de codage WordPress et en testant le plugin avec différents thèmes.
• Le débogage d'un plugin WordPress implique l'utilisation du système de débogage intégré ou d'un PHP IDE avec un débogueur. Assurer la sécurité du plugin implique de valider et de désinfecter la saisie des utilisateurs, à utiliser les nonces pour vérifier les sources de demande, la définition des autorisations de fichiers appropriées et l'utilisation des fonctions API WordPress pour la manipulation des données. Les mises à jour et les tests réguliers peuvent aider à identifier les vulnérabilités de sécurité potentielles.

Le fichier de plugin principal

Les plugins sont détectés automatiquement à partir du répertoire WP-Content / Plugins dans votre répertoire d'installation WordPress. Lors de la création d'un nouveau plugin, vous devez y créer un nouveau sous-répertoire. Le nom du sous-répertoire peut être tout ce que vous voulez; Une option raisonnable serait de l'appeler le nom de votre plugin. Essayez d'éviter des noms génériques tels que «TextWidget» ou «ShoppingCart» car cela peut déjà avoir été utilisé avec un autre plugin et causera des problèmes si vous souhaitez le distribuer à d'autres utilisateurs de WordPress. Pour cet exemple, créez un sous-répertoire nommé phpmaster_examplewidget. WordPress détecte qu'un plugin est disponible à partir d'un descripteur placé dans les commentaires d'un fichier PHP. Le descripteur doit fournir les informations de base sur ce que fait le plugin, qui les a créés et ses informations de licence. C'est ce que WordPress utilise pour identifier qu'un plugin est présent et prêt à être activé. Cet exemple de plugin contiendra la définition en haut un fichier placé dans votre répertoire phpmaster_examplewidget nouvellement créé. Le nom du fichier est également arbitraire, mais il est conseillé de fournir un nom de sens. Cet exemple appellera le fichier widget_init.php.

<span><span><?php
</span></span><span><span>/* 
</span></span><span><span>Plugin Name: Simple Text Plugin
</span></span><span><span>Plugin URI: http://www.example.com/textwidget
</span></span><span><span>Description: An example plugin to demonstrate the basics of putting together a plugin in WordPress
</span></span><span><span>Version: 0.1 
</span></span><span><span>Author: Tim Smith 
</span></span><span><span>Author URI: http://www.example.com
</span></span><span><span>License: GPL2 
</span></span><span><span>
</span></span><span><span>    Copyright 2011  Tim Smith
</span></span><span><span>
</span></span><span><span>    This program is free software; you can redistribute it and/or
</span></span><span><span>    modify it under the terms of the GNU General Public License,
</span></span><span><span>    version 2, as published by the Free Software Foundation. 
</span></span><span><span>
</span></span><span><span>    This program is distributed in the hope that it will be useful,
</span></span><span><span>    but WITHOUT ANY WARRANTY; without even the implied warranty of 
</span></span><span><span>    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
</span></span><span><span>    GNU General Public License for more details. 
</span></span><span><span>
</span></span><span><span>    You should have received a copy of the GNU General Public License 
</span></span><span><span>    along with this program; if not, write to the Free Software 
</span></span><span><span>    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 
</span></span><span><span>    02110-1301  USA 
</span></span><span><span>*/</span></span>

Il s'agit de la structure requise pour tout plugin que vous allez créer pour WordPress. Maintenant, lorsque vous vous connectez et regardez l'écran d'administration du plugin dans WordPress, vous verrez que le nouveau plugin est prêt pour l'activation.

Vous pouvez voir toutes les informations que vous avez saisies dans la section des commentaires décrivant le plugin s'affiche ici. Vous pouvez l'activer maintenant si vous le souhaitez, mais vous devez toujours ajouter des fonctionnalités avant qu'il ne fasse quoi que ce soit. Le fichier qui a cette définition est désormais considéré comme le point de départ de tout code associé au plugin. Le code qui apparaît après les commentaires de définition sera exécuté vous donnant la possibilité d'initialiser le plugin et ses fonctionnalités.

widgets wordpress

WordPress fournit une classe que vous pouvez étendre nommée WP_Widget. Lorsque vous l'étendez, votre propre widget sera disponible pour toute barre latérale que votre thème propose. WordPress est expédié avec un certain nombre de widgets par défaut tels que les «publications récentes» et les «archives» qui étendent WP_Widget. La classe WP_Widget fournit quatre méthodes qui doivent être remplacées:

• __ Construction () - Appelez le constructeur parent et initialisez toutes les variables de classe
• form () - Affichez un formulaire pour le widget dans la vue d'administration pour personnaliser les propriétés du widget
• Update () - Mettez à jour les propriétés du widget spécifié dans le formulaire dans la vue d'administration
• widget () - Afficher le widget sur le blog

le constructeur

Le constructeur est comme tout autre constructeur que vous avez probablement écrit. La chose importante à retenir ici est d'appeler le constructeur parent qui peut prendre trois arguments: un identifiant pour le widget, le nom amical du widget (cela apparaîtra comme le titre du widget dans l'écran du widget d'administration) et un tableau Détaillant les propriétés du widget (qui n'a besoin que d'une valeur de «description»).

<span><span><?php
</span></span><span><span>/* 
</span></span><span><span>Plugin Name: Simple Text Plugin
</span></span><span><span>Plugin URI: http://www.example.com/textwidget
</span></span><span><span>Description: An example plugin to demonstrate the basics of putting together a plugin in WordPress
</span></span><span><span>Version: 0.1 
</span></span><span><span>Author: Tim Smith 
</span></span><span><span>Author URI: http://www.example.com
</span></span><span><span>License: GPL2 
</span></span><span><span>
</span></span><span><span>    Copyright 2011  Tim Smith
</span></span><span><span>
</span></span><span><span>    This program is free software; you can redistribute it and/or
</span></span><span><span>    modify it under the terms of the GNU General Public License,
</span></span><span><span>    version 2, as published by the Free Software Foundation. 
</span></span><span><span>
</span></span><span><span>    This program is distributed in the hope that it will be useful,
</span></span><span><span>    but WITHOUT ANY WARRANTY; without even the implied warranty of 
</span></span><span><span>    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
</span></span><span><span>    GNU General Public License for more details. 
</span></span><span><span>
</span></span><span><span>    You should have received a copy of the GNU General Public License 
</span></span><span><span>    along with this program; if not, write to the Free Software 
</span></span><span><span>    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 
</span></span><span><span>    02110-1301  USA 
</span></span><span><span>*/</span></span>

Avec la structure du widget de base en place, vous souhaitez enregistrer le widget et vous assurer que cela se fait à un moment où tous les autres widgets sont en cours d'initialisation. L'enregistrement d'un widget est effectué via la fonction register_widget () qui prend un seul argument, le nom de la classe qui étend wp_widget. Cet appel pour enregistrer le widget doit être appelé à un moment approprié, de sorte que le crochet WordPress particulier que vous voudrez utiliser est appelé "widgets_init". Pour associer l'enregistrement du widget avec le crochet, vous utilisez add_action () qui prend le nom du crochet comme premier argument et une fonction à exécuter en tant que seconde. (Le deuxième argument peut être le nom de chaîne d'une fonction ou d'une fermeture.) Ce code doit passer directement sous le descripteur du plugin créé dans widget_init.php.

<span><span><?php
</span></span><span><span>class TextWidget extends WP_Widget
</span></span><span><span>{
</span></span><span>    <span>public function __construct() {
</span></span><span>        <span><span>parent::</span>__construct("text_widget", "Simple Text Widget",
</span></span><span>            <span>array("description" => "A simple widget to show how WP Plugins work"));
</span></span><span>    <span>}
</span></span><span><span>}</span></span>

Maintenant qu'il a été enregistré et initialisé, vous pourrez voir votre widget disponible pour une utilisation.

la méthode form ()

L'exemple de widget ici devrait vous permettre d'entrer un titre et un texte à afficher lorsqu'il est affiché sur le blog, afin de pouvoir modifier ces deux aspects du widget, vous devez créer un formulaire pour inviter ces valeurs. La méthode Form () est utilisée dans l'écran d'administration du widget pour afficher les champs que vous pouvez utiliser plus tard pour modifier les fonctionnalités du widget sur le site lui-même. La méthode prend un argument, un tableau d'instance $ de variables associé au widget. Lorsque le formulaire est soumis, le widget appellera la méthode Update () qui vous permet de mettre à jour les champs en instance $ avec de nouvelles valeurs. Plus tard, widget () sera appelé et utilisera l'instance $ pour afficher les valeurs.

<span><span><?php
</span></span><span><span>add_action("widgets_init",
</span></span><span>    <span>function () { register_widget("TextWidget"); });
</span></span><span><span>?></span></span>

Vous utilisez la méthode WP_Widget Get_field_id () et la méthode get_field_name () pour créer respectivement des ID et des noms pour les champs de formulaire. WordPress générera des identificateurs uniques pour vous afin de ne pas s'affronter avec d'autres widgets utilisés, et lorsque le formulaire est soumis, les valeurs mettront à jour les éléments de tableau d'instance $ pertinents. Vous pouvez utiliser l'argument de l'instance passée à faire pour remplir les champs de formulaire avec des valeurs s'ils sont déjà définis. Voici à quoi ressemble le formulaire dans la vue d'administration:

L'élément Parent

lui-même, le bouton de sauvegarde et les liens de suppression et de fermeture sont générés pour vous automatiquement par WordPress, il n'est donc pas nécessaire de les coder explicitement. Le formulaire affichera les variables et appellera la méthode Update () afin que les nouvelles valeurs puissent être insérées dans l'instance $.

La méthode Update ()

mise à jour() vous donne l'occasion de valider et de désinfecter les variables d'instance avant d'être utilisées par le widget. Ici, vous pouvez prendre des décisions en fonction des anciennes valeurs et mettre à jour les nouvelles valeurs en conséquence. Update () doit renvoyer un tableau qui contient les éléments que vous attendez d'utiliser lors de l'affichage du widget. WordPress y transmet deux arguments, un tableau avec les nouvelles valeurs d'instance du formulaire et un tableau avec les valeurs d'instance d'origine.

<span><span><?php
</span></span><span><span>/* 
</span></span><span><span>Plugin Name: Simple Text Plugin
</span></span><span><span>Plugin URI: http://www.example.com/textwidget
</span></span><span><span>Description: An example plugin to demonstrate the basics of putting together a plugin in WordPress
</span></span><span><span>Version: 0.1 
</span></span><span><span>Author: Tim Smith 
</span></span><span><span>Author URI: http://www.example.com
</span></span><span><span>License: GPL2 
</span></span><span><span>
</span></span><span><span>    Copyright 2011  Tim Smith
</span></span><span><span>
</span></span><span><span>    This program is free software; you can redistribute it and/or
</span></span><span><span>    modify it under the terms of the GNU General Public License,
</span></span><span><span>    version 2, as published by the Free Software Foundation. 
</span></span><span><span>
</span></span><span><span>    This program is distributed in the hope that it will be useful,
</span></span><span><span>    but WITHOUT ANY WARRANTY; without even the implied warranty of 
</span></span><span><span>    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
</span></span><span><span>    GNU General Public License for more details. 
</span></span><span><span>
</span></span><span><span>    You should have received a copy of the GNU General Public License 
</span></span><span><span>    along with this program; if not, write to the Free Software 
</span></span><span><span>    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 
</span></span><span><span>    02110-1301  USA 
</span></span><span><span>*/</span></span>

WordPress persistera ces valeurs pour vous, il n'est donc pas nécessaire d'implémenter cette fonctionnalité.

La méthode widget ()

La méthode widget () est utilisée pour afficher le contenu dans le widget lorsqu'il apparaît dans la barre latérale de votre blog. La sortie de la méthode rendra la page de blog. WordPress passe la méthode widget () deux arguments: le premier est $ args qui est un tableau détaillant des informations sur le widget, et la seconde est l'instance $ que vous pouvez utiliser pour obtenir la sortie les données associées au widget. $ args n'affectera vraiment pas cet exemple, donc je ne vais pas y entrer; N'oubliez pas que $ instance est le deuxième argument.

<span><span><?php
</span></span><span><span>class TextWidget extends WP_Widget
</span></span><span><span>{
</span></span><span>    <span>public function __construct() {
</span></span><span>        <span><span>parent::</span>__construct("text_widget", "Simple Text Widget",
</span></span><span>            <span>array("description" => "A simple widget to show how WP Plugins work"));
</span></span><span>    <span>}
</span></span><span><span>}</span></span>

Cela produira la sortie possible suivante sur le site:

Et c'est tout! Assurer tout cela ensemble vous donnera un widget très simple pour afficher du texte du côté du blog d'une installation WordPress.

Résumé

Vous connaissez maintenant les bases nécessaires pour un plugin WordPress qui garantit que WordPress peut détecter et l'activer, et prolonger la classe WP_Widget pour créer vos propres widgets. L'exemple de widget présenté dans cet article a démontré la possibilité de personnaliser l'affichage du widget via un formulaire de configuration fourni par l'administrateur. Bien que simple, il a mis en évidence les méthodes de base WP_Widget que vous utiliserez et vous pourrez facilement passer à partir de cet exemple et créer de plus grandes fonctionnalités pour vos propres sites axés sur WordPress. Le code de cet exemple est disponible sous le compte GitHub de PHPMaster afin que vous puissiez jeter un œil au code dans son intégralité. Image via Bioraven / Shutterstock

Des questions fréquemment posées sur le développement du plugin WordPress

Comment commencer à développer un plugin WordPress?

Pour commencer à développer un plugin WordPress, vous devez avoir une compréhension de base de PHP, HTML, CSS et JavaScript. Une fois que vous avez ces compétences, vous pouvez commencer par créer un nouveau dossier dans votre répertoire de plugins WordPress. Nommez ce dossier après votre plugin. À l'intérieur de ce dossier, créez un fichier PHP avec le même nom. Ce fichier servira de fichier principal pour votre plugin. Dans ce fichier, vous devrez inclure un commentaire d'en-tête qui indique à WordPress qu'un plugin existe ici. Après avoir mis en place la structure de base, vous pouvez commencer à écrire les fonctionnalités de votre plugin.

Quelles sont les meilleures pratiques pour le développement du plugin WordPress?

Certaines des meilleures pratiques pour le développement du plugin WordPress incluent: Utiliser les conventions de dénomination appropriées pour éviter que le nom de fonction entre les conflits avec d'autres plugins, en utilisant des crochets et des filtres WordPress lorsque cela est possible, en vous assurant que votre plugin est sécurisé en validant et en désinfectant la saisie des utilisateurs, et en créant votre plugin traduisible pour atteindre un public plus large. Il est également important de garder votre code propre et bien collectionné pour les références et les mises à jour futures.

Comment puis-je rendre mon plugin WordPress compatible avec tous les thèmes?

Assurer que votre plugin WordPress est compatible avec tous Les thèmes peuvent être difficiles en raison du grand nombre de thèmes disponibles. Cependant, l'adhésion aux normes de codage WordPress, l'utilisation de crochets et de filtres au lieu de modifier les fichiers centraux, et tester votre plugin avec différents thèmes peut aider à garantir la compatibilité. Il est également recommandé de fournir une documentation claire et une prise en charge de vos utilisateurs de plugin.

Comment déboguer mon plugin WordPress?

Le débogage de votre plugin WordPress implique d'identifier et de résoudre tout problème ou erreur qui peut survenir pendant son développement. WordPress est livré avec un système de débogage intégré que vous pouvez activer dans votre fichier wp-config.php. En définissant WP_Debug sur true, vous pouvez afficher les erreurs PHP à l'avant de votre site Web. De plus, l'utilisation d'un PHP IDE avec un débogueur peut vous aider à parcourir votre code et à trouver des problèmes plus efficacement.

Comment puis-je assurer la sécurité de mon plugin WordPress?

Assurer la sécurité de votre Le plugin WordPress implique plusieurs étapes. Tout d'abord, validez et désinfectant toujours les entrées des utilisateurs pour éviter les attaques d'injection SQL. Deuxièmement, utilisez les nonces pour vérifier la source des demandes. Troisièmement, utilisez des autorisations de fichiers appropriées dans vos fichiers de plugin. Quatrièmement, utilisez les fonctions API WordPress pour la manipulation des données au lieu des requêtes SQL personnalisées. Enfin, mettre à jour et tester régulièrement votre plugin pour toutes les vulnérabilités de sécurité potentielles.

Comment faire de mon plugin WordPress SEO-Friendly?

Faire de votre plugin WordPress SEO-Friendly implique de s'assurer qu'il ne le fait pas ' T a un impact négatif sur la vitesse de chargement du site Web, car il s'agit d'un facteur clé dans le référencement. De plus, si votre plugin ajoute du contenu sur le site Web, assurez-vous qu'il est facilement excité et indexable par les moteurs de recherche. Si votre plugin implique des images, assurez-vous d'ajouter des balises ALT. Enfin, assurez-vous que votre plugin est compatible avec les plugins SEO populaires.

Comment mettre à jour mon plugin WordPress?

La mise à jour de votre plugin WordPress implique d'effectuer les modifications nécessaires dans vos fichiers de plugin, puis d'intégration de la version Numéro dans le commentaire de l'en-tête de votre plugin. Une fois que vous avez testé la version mise à jour et vous assuré correctement, vous pouvez le télécharger dans le référentiel de plugin WordPress. Si votre plugin est hébergé sur le référentiel de plugin WordPress, les utilisateurs seront informés de la mise à jour de leur tableau de bord WordPress.

Comment puis-je faire de mon plugin WordPress convivial?

L'utilisateur implique de fournir une documentation claire et détaillée, y compris des captures d'écran ou des vidéos si nécessaire. Assurez-vous également que les paramètres et les options de votre plugin sont intuitifs et faciles à comprendre. La fourniture d'un support rapide et utile peut également améliorer considérablement l'expérience utilisateur.

Comment tester mon plugin WordPress?

Tester votre plugin WordPress implique de vérifier ses fonctionnalités dans différents scénarios et avec différents thèmes et plugins. Vous pouvez utiliser des outils de test automatisés comme PHPUnit pour les tests unitaires. Envisagez également d'utiliser des outils de débogage pour identifier les erreurs ou les problèmes. C'est aussi une bonne idée d'avoir des testeurs bêta qui peuvent fournir des commentaires avant de libérer votre plugin.

Comment puis-je monétiser mon plugin WordPress?

Il existe plusieurs façons de monétiser votre plugin WordPress. Vous pouvez offrir une version gratuite avec des fonctionnalités de base et une version premium avec des fonctionnalités avancées. Vous pouvez également offrir des modules complémentaires payants pour votre plugin gratuit. Une autre option consiste à offrir votre plugin gratuitement et à fournir un support payant ou des services de développement personnalisés.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!