Mettez le plugin sur WordPress.org
Vous avez une idée de génie pour un tout nouveau plugin ? Vous avez créé une extension qui révolutionne WordPress mais vous ne savez pas comment la partager avec la communauté ?
Découvrons ensemble comment déployer et publier une extension sur WordPress.org (pour rappel, WordPress.org recense et propose des plugins à toute la communauté WordPress !).
Et pour cela, je vous propose… d’utiliser PHP Code Sniffer !
Vérifiez votre code avec PHP Code Sniffer
PHPCS (PHP CodeSniffer) est un outil de vérification de code open source pour PHP. Il permet de détecter les erreurs de syntaxe, les erreurs de style, les problèmes de sécurité et les mauvaises pratiques de codage dans les fichiers PHP.
PHPCS utilise une série de règles prédéfinies appelées "standards" pour vérifier la qualité du code. Il est livré avec un ensemble de standards intégrés, tels que PSR-1, PSR-12, Zend, WordPress, Drupal. Les standards sont configurables et personnalisables en fonction des besoins du projet.
PHPCS peut être utilisé en ligne de commande pour vérifier le code dans les fichiers PHP individuels ou dans des projets entiers. Il peut également être intégré à des outils de développement tels que des éditeurs de code, des systèmes de gestion de versions et des outils de construction, pour automatiser la vérification de la qualité du code.
En utilisant PHPCS, les développeurs PHP peuvent garantir que leur code est conforme aux normes de codage établies et qu'il est cohérent, facile à lire et à maintenir. Cela peut contribuer à améliorer la qualité du code, à réduire les bugs et les erreurs, à faciliter la collaboration entre les membres de l'équipe et à accélérer le processus de développement.
Ici, notre intérêt réside dans le fait de vérifier de manière automatique que le code de notre nouveau plugin correspond bien aux bonnes pratiques de développement, dans le but de pouvoir le soumettre et le faire valider le plus rapidement possible.
Pour ce faire, commencez par installer PHPCS en téléchargeant le package. Puis :
Créez un fichier de configuration
phpcs.xmlà la racine de votre projet (dans notre cas, dans le répertoirewp-content/plugins/administration). Copiez le contenu des règles WordPress-Coding-Standards et collez-les dans votre fichier.Exécutez PHPCS en spécifiant le chemin du répertoire du plugin que vous souhaitez vérifier :
phpcs wp-content/plugins/administration.PHPCS analysera votre code à l'aide des règles de WordPress Coding Standards et affichera les problèmes détectés.
Identifiez les problèmes signalés par PHPCS et corrigez-les dans votre code. Certains problèmes peuvent être corrigés automatiquement en utilisant l'option
--fixlors de l'exécution de PHPCS.
Une fois que vous avez corrigé les problèmes, exécutez à nouveau PHPCS pour vous assurer que votre code est conforme aux règles de WordPress Coding Standards. Vérifiez également que votre plugin fonctionne toujours comme avant.
PHPCS est un outil précieux pour s'assurer que votre code respecte les règles de codage spécifiques de WordPress et améliore la qualité de votre plugin personnalisé. Utilisez-le pour détecter et corriger les problèmes potentiels avant de soumettre votre plugin pour examen sur WordPress.org, vous gagnerez ainsi du temps d’attente lors de la soumission de votre plugin.
Ajoutez votre plugin sur WordPress
Sous WordPress.org, chaque plugin doit avoir un fichier readme.txt qui respecte la norme de fichier readme d’un plugin WordPress. Ce fichier est une documentation détaillée expliquant comment utiliser votre plugin, mais permet également de partager un certain nombre d’informations.
Pour réaliser ceci, créez un fichier readme.txt à la racine de votre plugin wp-content/plugins/administration/readme.txt .
Nous allons le remplir en respectant la norme du fichier readme :
=== Administration ===
Contributors: openclassrooms
Tags: openclassrooms, cours wordpress, devenez expert wordpress
Requires at least: 6.0
Tested up to: 6.2
Stable tag: 1.0.0
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Administration est un plugin pour le cours WordPress d’OpenClassrooms.
== Description ==
Le plugin Administration proposé par OpenClassrooms permet d’activer une page d’administration ; celle-ci comporte un champ pour modifier la couleur de fond d’un site WordPress.Pour détailler et reprendre les éléments de ce fichier, nous avons donc :
le titre du plugin en haut du fichier ;
Contributors : la liste des noms d'utilisateurs sous WordPress.org gérant le plugin (séparés par des virgules) ;
Tags : une liste de mots clés séparés par des virgules (aide à la recherche de votre plugin dans la liste des plugins) ;
Requires at least : la version la plus basse sur laquelle le plugin fonctionnera ;
Tested up to : la version la plus élevée que vous avez utilisée avec succès pour tester votre plugin ;
Stable tag, qui doit indiquer la dernière version de votre plugin. Celle-ci doit tout le temps refléter la bonne version à jour de votre plugin ;
Requires PHP, qui doit indiquer la version minimum de PHP requise pour faire fonctionner votre plugin ;
License : la licence sous laquelle le plugin est distribué, c'est-à-dire les termes et conditions qui régissent son utilisation, sa redistribution et sa modification. Cet attribut indique la licence légale qui s'applique au plugin ;
License URI : l'URL (Uniform Resource Locator) où les utilisateurs peuvent trouver les détails complets de la licence du plugin. Il fournit un lien vers la ressource en ligne où les utilisateurs peuvent consulter les conditions et les termes de la licence dans leur intégralité ;
ensuite nous avons une courte phrase résumant brièvement le plugin ;
puis enfin, la longue description où vous pourrez détailler un maximum ce que fait votre plugin. Il n’y a aucune limite, et vous pouvez utiliser Markdown pour y ajouter vos informations.
Une fois votre fichier readme complété, il faudra créer une archive ZIP du plugin.
Pour cela, depuis votre explorateur (Windows, Mac, Linux), vous allez devoir faire un clic droit sur le dossier administration se trouvant dans le dossier wp-content/plugins/ , puis sélectionner l’option “compression”.
À partir de ce moment, vous pourrez proposer et soumettre votre plugin à l’équipe WordPress ; cela se fait de manière très simple.
Connectez-vous à votre compte sur WordPress.org.
Soumettez votre plugin pour examen : rendez-vous sur la page des plugins sur WordPress.org et cliquez sur le lien "Proposer un plugin" (ou "Submit a plugin", en anglais).
Cliquez sur “Select a file” et choisissez votre plugin compressé.
Cochez les différentes cases vous demandant la confirmation que vous et votre plugin respectent bien les règles WordPress. Puis cliquez sur Upload.
Une fois soumis, votre plugin sera examiné par l'équipe de relecture de plugins de WordPress.org. Cette période peut prendre un certain temps en fonction de la charge de travail de l'équipe. Elle vérifiera si votre plugin répond aux exigences de soumission, et s'il est sûr et fonctionnel.
Dès que l’examen sera réalisé, vous recevrez une notification par e-mail concernant l'approbation ou le rejet de votre plugin. Si votre plugin est approuvé, il sera publié sur WordPress.org et sera disponible pour être installé par les utilisateurs de WordPress. Si ce n’est pas le cas, l’e-mail mentionnera les choses à rectifier pour que votre plugin puisse être accepté sur WordPress.org.
Une fois votre plugin déployé sur WordPress.org, vous pourrez depuis votre compte :
garder une trace du nombre de personnes qui l'ont téléchargé ;
obtenir des commentaires de la part des utilisateurs sur votre plugin ;
faire évoluer votre plugin en lui apportant des mises à jour.
En résumé
Pour déployer un plugin, vous devez vérifier votre code et créer un fichier
readme.txtdans votre plugin.Afin de vérifier son code de manière automatique et d’éviter les déploiements d’un plugin à répétition, on peut utiliser l’outil PHPCS pour détecter des erreurs de code en se basant sur des règles de développement pour WordPress.
L’ensemble des étapes pour déployer votre plugin se réalisent sur WordPress.org avec un compte.
Un plugin peut être autorisé à apparaître dans la liste des plugins ou être refusé. Si cela se produit, vous recevrez une notification par e-mail vous expliquant comment résoudre les erreurs.
Ça y est ! Ce cours sur WordPress touche à sa fin. Revenons sur tout ce que vous venez de voir dans le chapitre de conclusion, puis n'oubliez pas de valider vos connaissances de cette troisième partie du cours avec un dernier quiz !
