Notez que cet article a été écrit il y a plus de 3 ans, mais il n'est pas forcément obsolète. Il a été mis à jour il y a moins de 4 mois.
Générateurs Yeoman
Yeoman est un projet Node.js permettant de créer, entre autres, un plugin wordPress en construisant la structure du plugin et utilisant les meilleurs pratiques.
On installe le package yo pour nodejs.
1 |
C:\Users\name > npm install -g yo |
On installe le générateur de plugins pour wordPress.
1 |
C:\Users\name > npm install -g generator-plugin-wp |
On se dirige vers le répertoire du plugin, et on lance le générateur.
1 |
K:\WP-Project\Plugin-Name > yo plugin-wp |
Différentes questions sur le nom du plugin, le slug, la classe, la licence, l’auteur … sont posées, puis on lance la génération. À la fin du processus, on obtient quelque chose comme cela.
On peut ensuite générer différents composants d’un plugin wp en exécutant des sous-générateurs dans le répertoire du plugin.
- yo plugin-wp:include <include-name> Basic Include
- yo plugin-wp:cpt <cpt-name> Custom Post Type
- yo plugin-wp:cli <cli-command-name>
WP CLI Command - yo plugin-wp:taxonomy <taxonomy-name>
Taxonomy - yo plugin-wp:options <options-name> Option Page
- yo plugin-wp:widget <widget-name> Widget
- yo plugin-wp:endpoint <class-name> WP-API Endpoint
- yo plugin-wp:js Javascript
- yo plugin-wp:css Styles
Pour les noms des sous-générateurs include, cpt, options et widget, le préfixe du plugin sera ajouté au nom de la classe. Il n’est donc pas nécessaire d’inclure le nom du plugin d’origine et pensez au nom du fichier à la place.
Pour installer les mises à jour, on relance simplement les mêmes commandes. Si la commande yo
n’est plus reconnue dans Windows
, on ajoute juste le chemin de npm
dans le path
.
On cherche path
dans windows, cela nous donne Edit the system environment variables
du Control panel
. On lance, et l’on obtient une fenêtre modale System Properties
. Et l’on clique en bas : Environment Variables
.
On sélectionne Path
dans la zone System Variables
ou User variables
pour l’utilisateur s’il n’y a que vous qui utilisez l’ordinateur. On clique alors sur Edit
:
On entre le chemin :
1 |
C:\Users\xavier_bs\AppData\Roaming\npm |
Et hop, un moyen très pratique pour créer un plugin wordPress. Yeoman possède de nombreux autres générateurs à découvrir.