Comment ajouter votre plugin au répertoire des plugins WordPress
Souhaitez-vous ajouter un plugin que vous avez créé au répertoire des plugins WordPress ?
Contribuer à des plugins utiles au répertoire n’est qu’une des façons dont vous pouvez redonner à la communauté WordPress.
Dans cet article, nous discuterons des avantages de l’ajout de votre plugin au répertoire des plugins WordPress, ainsi qu’un guide étape par étape sur la façon d’ajouter votre plugin au référentiel.
Pourquoi ajouter votre plugin au répertoire des plugins WordPress ?
Si vous avez créé un plugin WordPress qui, selon vous, pourrait être utile à d’autres, vous devriez envisager de l’ajouter au répertoire officiel des plugins WordPress. Cela présente de nombreux avantages pour vous en tant que développeur.
Le répertoire des plugins WordPress est le premier endroit où se tournent de nombreux utilisateurs lorsqu’ils recherchent des plugins pour leur site Web WordPress. L’ajout de votre plugin au répertoire facilitera la recherche des utilisateurs et vous donnera une plus grande crédibilité en tant que développeur.
Vous n'aurez pas à payer pour la bande passante requise pour télécharger votre plugin, et le répertoire gardera automatiquement une trace du nombre de personnes l'ayant téléchargé et les avertira en cas de mise à niveau.
Le répertoire vous aidera également à prendre en charge le plugin. Les utilisateurs peuvent évaluer votre plugin, laisser des commentaires et des rapports de bogues, et utiliser le forum d'assistance.
Bien entendu, il existe également certaines exigences et restrictions. La première est que votre plugin doit avoir une licence compatible avec WordPress. GPLv2 ou version ultérieure est recommandé.
Il y a également certaines considérations éthiques à garder à l’esprit. Le plugin ne doit rien faire d’illégal ou de moralement offensant, et vous ne pouvez pas inclure de liens vers des sites Web externes sans obtenir au préalable l’autorisation des utilisateurs.
Après avoir soumis le plugin, il sera examiné manuellement pour détecter les erreurs courantes et pour s'assurer que vous avez suivi les directives du répertoire du plugin. Ce processus peut prendre entre 1 et 10 jours.
Cela étant dit, voyons étape par étape comment ajouter votre plugin au répertoire des plugins WordPress.
Création d'un fichier readme.txt pour votre plugin
La première chose que vous devez faire est de créer un fichier « Lisez-moi » pour votre plugin. Celui-ci sera affiché sur la page de votre plugin dans le répertoire et doit utiliser le bon formatage.
Voici un exemple de fichier que vous pouvez utiliser comme point de départ. Vous devrez le coller dans votre éditeur de texte et enregistrer le fichier sous readme.txt dans votre dossier plugin :
=== Your Plugin Name ===
Contributors: Your WordPress.org Username
Tags: wpbeginner, plugin tutorial
Requires at least: 6.0
Tested up to: 6.2
Stable tag: 1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
A WordPress plugin to teach beginners how to write a WordPress plugin.
== Description ==
This simple plugin is part of our beginner's guide to writing a WordPress plugin.
== Installation ==
1. Upload the plugin folder to your /wp-content/plugins/ folder.
1. Go to the **Plugins** page and activate the plugin.
== Frequently Asked Questions ==
= How do I use this plugin? =
Answer to the question
= How to uninstall the plugin? =
Simply deactivate and delete the plugin.
== Screenshots ==
1. Description of the first screenshot.
1. Description of the second screenshot.
== Changelog ==
= 1.0 =
* Plugin released.
Vous devrez personnaliser le fichier pour votre propre plugin, nous expliquerons donc comment fonctionne la syntaxe du fichier readme du plugin WordPress.
La première ligne est le « Nom du plugin » et apparaîtra dans le répertoire du plugin WordPress comme titre de votre plugin.
La ligne suivante est « Contributeurs ». Ce sont les identifiants utilisateur WordPress.org responsables de la gestion de votre plugin. Si vous ne disposez pas déjà d’un identifiant, vous devrez créer un compte utilisateur WordPress.org gratuit.
Les champs « Nécessite au moins » et « Testé jusqu'à » font référence aux versions de WordPress avec lesquelles votre plugin fonctionne. La « balise stable » est la version de votre propre plugin.
Vous pouvez laisser les champs Licence inchangés. Ensuite, vous devez modifier la zone « Description » pour expliquer ce que fait votre plugin.
Après avoir modifié le fichier Lisez-moi de votre plugin, n'oubliez pas de sauvegarder vos modifications. C'est également une bonne idée d'exécuter le fichier via le validateur Readme officiel et de résoudre tous les problèmes identifiés.
Enfin, vous devez cliquer avec le bouton droit sur le dossier de votre plugin et créer un fichier zip. Les utilisateurs Mac doivent sélectionner « Compresser le nom du plugin » et les utilisateurs Windows peuvent sélectionner « Envoyer vers » Dossier compressé (zippé) ».
Soumettre votre plugin à l'annuaire pour examen
Votre plugin est maintenant prêt à être examiné par l’équipe des plugins de WordPress.org.
Pour le soumettre, visitez la page Ajouter votre plugin. Si vous n'êtes pas déjà connecté, cliquez sur le bouton « Connexion » dans le coin supérieur droit de l'écran.
Une fois connecté, vous pourrez télécharger et soumettre votre plugin pour examen.
Cliquez simplement sur le bouton « Sélectionner un fichier » pour sélectionner le fichier zip de votre plugin, puis cliquez sur le bouton « Télécharger ».
L’équipe d’examen des plugins WordPress.org examinera ensuite le code de votre plugin pour détecter les erreurs courantes et les contrôles de sécurité. Une fois approuvé, vous recevrez un e-mail de l’équipe des plugins.
Cet e-mail contiendra un lien vers le référentiel Subversion (SVN) où votre plugin sera hébergé sur WordPress.org. Vous devrez utiliser ce lien lorsque vous téléchargerez votre plugin.
Télécharger votre plugin à l'aide de Subversion (SVN)
Une fois votre plugin approuvé, vous devrez utiliser Subversion (SVN) pour télécharger le plugin.
Subversion est un système de contrôle de version open source. Il permet aux utilisateurs d'apporter des modifications aux fichiers et aux répertoires tout en conservant une trace des modifications, en gérant différentes versions et en collaborant avec d'autres utilisateurs.
Vous aurez besoin d'un client SVN installé sur votre ordinateur pour télécharger votre plugin. Les utilisateurs Windows peuvent utiliser SilkSVN ou TortoiseSVN (gratuit). Les utilisateurs Mac peuvent installer SmartSVN ou l'application Versions sur leur ordinateur.
Dans cet article, nous utiliserons l'application Versions pour Mac. Cependant, le processus est très similaire dans toutes les applications SVN répertoriées ci-dessus.
Une fois installé, vous devez ouvrir l’application Versions et consulter une copie du référentiel de votre plugin WordPress. Pour ce faire, cliquez simplement sur le bouton « Nouveau signet du référentiel ».
Cela fera apparaître une fenêtre contextuelle dans laquelle vous devrez d'abord fournir un nom pour ce signet. Vous pouvez lui donner le nom de votre plugin. Après cela, vous devez ajouter l’URL du référentiel SVN de votre plugin WordPress.
Vous pouvez laisser les champs du nom d'utilisateur et du mot de passe vides.
Vous devez maintenant cliquer sur le bouton « Créer ». Les versions se connecteront à votre référentiel et téléchargeront une copie du référentiel de votre plugin sur votre ordinateur.
Ensuite, vous devez cliquer avec le bouton droit sur le nom du référentiel dans la vue du navigateur, puis sélectionner « Checkout ».
Il vous sera demandé de fournir un nom pour le dossier et de sélectionner un emplacement où vous souhaitez le stocker sur votre ordinateur. Vous pouvez utiliser le même nom de dossier que votre répertoire de plugins et cliquer sur le bouton « Commander » pour continuer.
L'application Versions va maintenant créer les dossiers nécessaires à votre plugin sur votre ordinateur. Vous pouvez le visualiser dans le référentiel de votre plugin ou le parcourir dans le Finder.
Vous devez maintenant copier les fichiers de votre plugin et les coller dans le dossier tronc de votre référentiel local.
Ce faisant, vous remarquerez une icône de point d'interrogation à côté des nouveaux fichiers dans l'application Versions.
Comme ces fichiers n’existaient pas auparavant, vous devez les ajouter. Sélectionnez les nouveaux fichiers et cliquez sur le bouton « Ajouter » pour ajouter ces fichiers à votre dossier local.
Maintenant que vos fichiers de plugin sont ajoutés dans Subversion, vous êtes prêt à les télécharger. Pour ce faire, synchronisez les modifications dans votre dossier local et le répertoire Subversion.
Vous devez cliquer sur votre référentiel local pour le sélectionner, puis cliquer sur l'icône « Valider ».
Une nouvelle fenêtre contextuelle apparaîtra et vous verrez la liste des modifications et une boîte pour ajouter un message de validation.
Une fois que vous avez cliqué sur le bouton « Valider », l'application Versions synchronisera vos modifications et les validera dans le référentiel de votre plugin.
Maintenant que vous avez téléchargé vos fichiers de plugin sur le tronc, il est temps de les étiqueter vers une version.
Accédez à la copie locale de votre plugin et copiez les fichiers dans le dossier tronc. Après cela, vous devez ouvrir le dossier tags et créer un nouveau dossier à l'intérieur.
Nommez ce dossier avec un nom de version. Assurez-vous qu'il correspond à la version que vous avez saisie dans l'en-tête de votre plugin. Dans l'exemple de code ci-dessus, nous avons utilisé la version 1.0 pour notre plugin.
Après avoir ajouté le dossier 1.0, vous devez y coller les fichiers de votre plugin. Puisqu'il s'agit d'un nouveau dossier, vous devrez également cliquer sur le bouton « Ajouter » pour inclure le dossier et tous ses fichiers dans le référentiel.
Après cela, vous pouvez continuer et cliquer sur l'icône « Valider » pour synchroniser vos modifications comme vous l'avez fait précédemment. Vous pouvez maintenant visiter le répertoire des plugins WordPress et prévisualiser votre plugin.
Chaque fois que vous devez modifier les fichiers de votre plugin, vous devez modifier la copie locale. Une fois que vous avez terminé vos modifications, cliquez simplement sur l'icône « Valider » pour les synchroniser avec le répertoire du plugin WordPress.
Lorsque vous avez apporté des modifications majeures à votre plugin, vous souhaiterez ajouter une nouvelle version en ajoutant un nouveau dossier avec ce numéro de version au dossier des balises. Assurez-vous que le numéro de version correspond à l’en-tête de votre plugin.
Ajout d'illustrations au répertoire des plugins WordPress
Nous pouvons maintenant ajouter des illustrations et des captures d'écran au répertoire du plugin WordPress. Ces éléments doivent suivre les pratiques de dénomination standard et doivent être téléchargés à l'aide de Subversion.
Bannière d'en-tête du plugin
La bannière d'en-tête est la grande image qui apparaît en haut de la page du plugin. Sa taille doit être de 772×250 ou 1544×500 pixels et vous devez utiliser le format de fichier JPEG ou PNG.
En fonction de la taille de votre image et du type de fichier, vous devrez donner à votre bannière d'en-tête l'un de ces noms :
bannière-772×250.jpg
bannière-772×250.png
bannière-1544×500.jpg
bannière-1544×500.png
Icône du plug-in
L'icône est une image carrée plus petite et sera affichée dans les résultats de recherche et les listes de plugins. Sa taille doit être de 125×125 ou 250×250 pixels et vous devez utiliser le format de fichier JPEG ou PNG.
En fonction de la taille de votre image et du type de fichier, vous devrez donner à votre icône l'un de ces noms :
icône-128×128.jpg
icône-128×128.png
icône-256×256.jpg
icône-256×256.png
Captures d'écran
Vous pouvez ajouter autant de captures d'écran que vous le souhaitez. Ces captures d'écran doivent être répertoriées dans les descriptions de capture d'écran de votre fichier readme.txt.
Les fichiers de capture d'écran doivent être nommés comme ceci :
capture d'écran-1.png
capture d'écran-2.png
Une fois que vous avez préparé toutes les illustrations, vous pouvez les placer dans le dossier d'actifs de la copie locale de votre plugin.
Après cela, vous remarquerez une icône de point d'interrogation à côté du dossier des ressources. Vous devrez cliquer sur le bouton « Ajouter » pour ajouter de nouveaux fichiers d'actifs dans votre référentiel.
Enfin, continuez et cliquez sur l'icône « Commit » pour télécharger vos fichiers dans le répertoire du plugin WordPress.
Après un certain temps, vous pourrez voir l'illustration apparaître sur la page de votre plugin.
Nous espérons que ce tutoriel vous a aidé à apprendre comment ajouter votre plugin au répertoire des plugins WordPress. Vous pouvez également consulter notre sélection de plugins indispensables que les utilisateurs de WordPress trouvent utiles et apprendre comment empêcher les clients de désactiver les plugins WordPress.
Si vous avez aimé cet article, abonnez-vous à notre chaîne YouTube pour les didacticiels vidéo WordPress. Vous pouvez également nous trouver sur Twitter et Facebook.