Accélérer le développement à l'aide de la bine-plaque de plugin WordPress

Développement du plugin WordPress: Utilisation de la chaudière de plugin WordPress

Le développement du plug-in WordPress a une courbe d'apprentissage faible et il n'y a pas seulement un moyen de créer des plug-ins. Les plugins peuvent être aussi simples que Hello Dolly, juste un seul fichier; La bailliche de plugin WordPress est conçue pour fournir une fondation standardisée et de haute qualité qui vous aide à construire votre prochain grand plugin. Dans la première partie de cette série, nous explorerons en profondeur le passe-partout, y compris la structure des fichiers et des dossiers, ainsi que l'organisation du code de la buissier.

Points clés

• Plugin WordPress Plugin propose une base standardisée et de haute qualité pour la création de plugins WordPress, avec une courbe d'apprentissage faible, et peut être utilisé de manière flexible pour des structures de plugin simples ou complexes.
• La version 3.0.0 de la passerelle a apporté des améliorations significatives dans la séparation de l'organisation du code et les préoccupations internes entre les plug-ins et peut être facilement obtenue en clonage le référentiel GIT ou en téléchargeant des fichiers ZIP à partir du référentiel Github.
• La baillon suit les normes de codage et de documentation WordPress recommandées, fournit des guides de démarrage et des recommandations d'outils utiles, et comprend cinq classes par défaut pour une variété de fonctionnalités, ce qui en fait un excellent point de départ pour les développeurs de plugins.

arrière-plan

La bailliser de plugin WordPress a été initialement lancée par Tom McFarlin pour fournir une approche axée sur l'objet standardisé pour construire des plugins WordPress. Étant donné que la plaque de buissier est construite sur l'API plug-in et suit les normes de codage et de documentation recommandées par WordPress, vous pouvez être sûr que vous êtes dans un environnement sûr et fiable. L'ébullieur a récemment été mis à jour vers la version 3.0.0, apportant des améliorations significatives de l'organisation du code et une séparation supplémentaire de la mise au point interne des plugins. Si vous connaissez déjà les plugins en développement avec le chaudron héritage (v2.6.2), il peut prendre un certain temps pour réapprendre ce qui est nouveau dans la dernière version, y compris la nouvelle structure de dossier. Cette passe-partout n'est plus entretenue par Tom McFarlin lui-même (au moment de la rédaction), et il a passé le bâton à Devin Vinson. Le développement se poursuit comme prévu, alors n'hésitez pas à le signaler dans votre référentiel GitHub si vous avez des questions. Nous accueillons également votre contribution.

Obtenez une copie de modèle

La façon la plus simple d'obtenir une copie de chauffeur du plugin WordPress est de cloner le référentiel GIT lui-même.

<code>git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git</code>

ou vous pouvez toujours télécharger des fichiers ZIP à partir de votre référentiel GitHub. Étant donné que la version 3.0.0 est publiée, vous ne pouvez pas simplement copier le plugin directement dans votre répertoire WP-Content / Plugins. En effet, le code source réel du plugin n'est pas inclus dans le répertoire racine, mais se trouve en fait dans un sous-répertoire appelé Trunk. Ne vous inquiétez pas maintenant, nous discuterons de la nouvelle structure de dossiers plus tard dans cet article. Le fichier readme.md détaille une description complète de la façon d'installer correctement le chauffeur. Bref, vous pouvez:

• Copiez le répertoire du tronc dans le dossier WP-Content / Plugins
• Copiez l'intégralité du répertoire du chaudron et créez un lien symbolique vers WP-CONTENT / PLUGINS / / pour le sous-répertoire du tronc. La création d'un lien symbolique dépendra du système d'exploitation que vous utilisez.

Après avoir fait cela, vous devriez maintenant trouver un plugin appelé WordPress Plugin Playplate dans la liste des plugins dans le panneau d'administration, en supposant que vous n'avez apporté aucune modification à la passe-partole elle-même. Activez simplement le plugin et commencez!

Personnalisez le plug-in avec générateur en ligne

Une fois activé, vous aurez un plugin "normal" qui ne fait rien - du moins pour l'instant. Vous devez également exécuter des opérations de recherche et de remplacement sur toute la base de code du chaudron, ce qui peut être très fastidieux et long. Heureusement, Enrique Chavez a créé un générateur non officiel qui automatise le processus. Visitez simplement https://www.php.cn/link/6340831392e9cd8af9598274f4b3c5c0 et remplissez le formulaire en bas de la page pour générer une copie personnalisée du modèle de plugin wordPress.

Structure du dossier

Voyons de plus près comment le boiard-plateau de plugin WordPress 3.0.0 est organisé par rapport aux anciennes versions. Comme mentionné précédemment, le code de plugin réel est contenu dans un sous-répertoire appelé Trunk, pas dans le répertoire racine. Il s'agit de suivre les normes utilisées dans le référentiel officiel du plugin WordPress, qui contient trois répertoires principaux: les actifs, les branches et le tronc. Le chauffeur en fournit déjà deux: des actifs et du coffre. Voici les répertoires et fichiers complets inclus dans la buissier (au moment de la rédaction):

<code>git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git</code>

Ce qui suit est une brève description des fonctions de chaque fichier et dossier:

• .gitignore: fournit une valeur par défaut raisonnable .gitignore pour la plupart des contenus qui ne devraient pas exister dans le référentiel GIT.
• CHANGELOG.md: Journal des modifications standard pour les modifications de la binelle, y compris la date de modification.
• README.md: Un démarreur utile avec les instructions d'installation répertoriées, ainsi que d'autres pièces telles que les recommandations d'outils et les remerciements.
• assets: Ce répertoire contient des ressources recommandées que vous devez fournir lorsque vous décidez de publier le plugin dans le référentiel de plugin WordPress. Toutes les images contenues dans ce répertoire sont de la résolution recommandée pour la publication.
• trunk: C'est le plugin réel que vous allez développer. Certains dossiers divisent la base de code en fonctionnalités administratives et orientées publiques. Nous expliquerons en détail ce que signifie chaque sous-répertoire.
  • admin: Le répertoire contient trois répertoires, à savoir admin, css et js. Comme son nom l'indique, toutes les fonctionnalités axées sur la gestion doivent être placées ici. Par défaut, partials et plugin-name-admin.js sont ajoutés à votre WP-Admin. plugin-name-admin.css fournira des fonctionnalités communes où vous pouvez définir des crochets spécifiques à la gestion. class-plugin-name-admin.php
  • : Ce répertoire est très similaire aux fonctionnalités fournies par le répertoire public, la seule différence est que le répertoire admin est utilisé pour stocker toutes les bases de code fonctionnel orientées publiques. public
  • : un fichier de démarrage languages où vous pouvez fournir des fonctionnalités de traduction pour les plugins. .pot
  • : C'est probablement là que presque tout le magie se produit. Par défaut, il existe cinq classes de départ, dont nous discuterons dans la section suivante. includes
  • : contient une copie de la licence GPL V2 par défaut. LICENSE.txt
  • : Le point de départ du fichier de réadme plug-in. Ce fichier couvre toutes les sections que vous pouvez encore remplir pour fournir une bonne page de plugin dans le référentiel de plugin WordPress. README.txt
  • : Le point d'entrée du plug-in. Ici, un en-tête de fichier de plugin commun est inclus que vous pouvez modifier en fonction de vos préférences. Si vous devez inclure une fonctionnalité lorsque le plugin est activé et / ou désactivé, plugin-name.php et register_activation_hook sera également enregistré dans ce fichier. register_deactivation_hook

Classes incluses

Comme mentionné précédemment, il existe cinq classes par défaut dans le répertoire

. Voyons ce que fait chaque classe: trunk/includes

• class-plugin-name-activator.php: Cette classe est instanciée pendant l'activation du plug-in. Il n'a qu'une seule méthode statique activate(), qui est enregistrée à register_activation_hook. Utilisez cette classe chaque fois que vous avez besoin d'effectuer certaines actions lorsque le plugin est activé, comme la création d'une table personnalisée ou l'enregistrement des options par défaut.
• class-plugin-name-deactivator.php: La catégorie correspondante de class-plugin-name-deactivator.php. Il n'a également qu'une seule méthode statique deactivate() qui peut être utilisée pour exécuter n'importe quelle fonctionnalité pendant la désactivation du plugin.
• class-plugin-name-i18n.php: Le point de départ de la fonction du plug-in i18n. Il a une propriété $domain qui stocke les champs de texte du plugin. Cette propriété peut être définie en utilisant la méthode publique set_domain(). Enfin, chaque fois que le plugin est chargé, la méthode load_plugin_textdomain() de cette classe est appelée.
• class-plugin-name-loader.php: La classe la plus importante du modèle. Il contient deux propriétés $actions et $filters, où tous les crochets enregistrés dans le plugin seront stockés. Il fournit deux fonctions de wrapper simples add_action() et add_filter() pour ajouter une action ou un filtre aux propriétés $actions et $filters. Cela ne doit pas être confondu avec les fonctions par défaut add_action() et add_filter() de WordPress, car de telles classes ne les enregistrent pas réellement directement. Tous les crochets ne seront enregistrés que lors d'une autre méthode appelée run().
• class-plugin-name.php: une classe qui colle toutes les parties ensemble. Il contient des informations importantes sur le plugin, telles que le nom et la version du plugin. De plus, il chargera les dépendances à l'aide de la méthode load_dependencies(), qui contiendra les quatre classes ci-dessus, et le champ de texte du plugin sera défini à l'aide de la méthode set_locale(). Tous les crochets administratifs et publics enregistrés précédemment peuvent également être définis ici. Cette classe fournit également des méthodes de GET simples telles que get_plugin_name() pour renvoyer le nom du plugin, get_version() pour renvoyer la version du plugin actuelle, et get_loader() pour préserver l'instance de class-plugin-name-loader.php.

Conclusion

En bref, le buisauche de plugin WordPress offre un excellent point de départ pour les développeurs de plugins. Il suit les normes de codage WordPress recommandées ainsi que les normes de documentation WordPress, vous savez donc que vous êtes sur le bon chemin dès le début. De plus, la publication d'un référentiel de plugin WordPress devient plus facile car Boilerplate fournit déjà la plupart de ce dont vous avez besoin. Une fois que nous connaissons l'organisation du code et la structure des dossiers, nous explorerons comment développer des plugins réels à l'aide de la bine-plaque de plugin WordPress dans la deuxième partie de cette série.

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!