Comment créer un plugin WordPress (étape par étape pour les débutants)

Nous avons créé de nombreux plugins WordPress au fil des ans, nous aidant ainsi que des milliers d'utilisateurs. Bon nombre de nos lecteurs nous ont demandé comment ils pouvaient créer leurs propres plugins.

Créer un plugin WordPress peut sembler difficile au début, mais c'est en fait assez amusant et gratifiant. Que vous souhaitiez ajouter une nouvelle fonctionnalité à votre site ou partager quelque chose d'utile avec d'autres, la création d'un plugin est un excellent moyen d'y parvenir.

Dans ce guide, nous vous montrerons comment créer votre premier plugin WordPress étape par étape.

Que faut-il pour créer votre premier plugin WordPress ?

Les plugins WordPress sont comme des applications pour votre site Web WordPress. Tout comme les applications sur votre téléphone, vous pouvez installer des plugins dans WordPress pour ajouter de nouvelles fonctionnalités.

Pour en savoir plus sur les plugins WordPress, consultez notre guide sur les plugins WordPress et leur fonctionnement.

Pour créer votre premier plugin WordPress, vous aurez besoin de connaissances de base en langages de codage tels que PHP, CSS, HTML et JavaScript.

Cela peut sembler beaucoup, mais ne vous inquiétez pas ; vous pouvez toujours suivre notre tutoriel. Nous vous guiderons tout au long du processus étape par étape, et à la fin, vous aurez une compréhension suffisante de la programmation WordPress pour créer un plugin WordPress simple.

Pour cette raison, nous nous en tiendrons aux bases et n'aborderons pas les compétences avancées en codage WordPress.

Deuxièmement, vous aurez besoin d'un environnement de développement local pour tester votre plugin WordPress sur votre ordinateur. Pour le configurer, consultez notre guide sur comment installer WordPress sur votre ordinateur Windows ou Mac).

Vous pouvez également tester votre plugin sur un site web de staging. Cependant, si une erreur se produit, vous risquez de casser votre site web, le rendant inaccessible.

Consultez notre guide sur la façon de corriger les erreurs WordPress courantes pour résoudre ces problèmes.

Vous aurez également besoin d'un éditeur de texte brut pour écrire votre code. Notepad ou TextEdit feront l'affaire. Cependant, si vous souhaitez essayer quelque chose de plus avancé, consultez ces éditeurs de code pour développeurs.

Une fois que tout est prêt, commençons le tutoriel. Vous pouvez utiliser les liens rapides ci-dessous pour passer à un sujet spécifique :

• Étape 1 : Créer un plugin WordPress de base
• Étape 2 : Installer et activer votre premier plugin WordPress
• Étape 3 : Soumettre votre plugin au dépôt de plugins WordPress.org
• Étape 4 : Utiliser Subversion (SVN) pour télécharger votre plugin
• Step 5: Add Artwork to Your Plugin on WordPress.org

Étape 1 : Créer un plugin WordPress de base

La première étape consiste à créer un nouveau dossier sur votre bureau ou dans votre dossier de documents et à le nommer quelque chose comme wpb-plugin-tutorial ou my-first-plugin.

Ensuite, vous devez créer un nouveau fichier dans votre éditeur de texte et l'enregistrer dans votre dossier de plugin sous le nom wpb-plugin-tutorial.php ou my-first-plugin.php. L'important est l'extension .php, mais vous pouvez nommer le fichier comme vous le souhaitez.

Vous devrez ouvrir ce fichier PHP avec votre éditeur de texte.

La première chose que vous devez ajouter à votre fichier de plugin est l'en-tête du plugin. Ce bloc de commentaires indique simplement à WordPress le nom de votre plugin, sa version, son site web, le nom de l'auteur du plugin, et plus encore :

/* Plugin Name: WPBeginner Plugin Tutorial Plugin URI: https://www.wpbeginner.com Description: A short little description of the plugin. It will be displayed on the Plugins page in WordPress admin area. Version: 1.0 Author: WPBeginner Author URI: https://www.wpbeginner.com License: GPL2 License URI: https://www.gnu.org/licenses/gpl-2.0.html Text Domain: wpb-tutorial Domain Path: /languages */ 

Après avoir ajouté l'en-tête du plugin, vous pouvez commencer à ajouter le code du plugin en dessous.

Pour ce tutoriel, nous allons créer un plugin simple qui ajoute un message à la fin de chaque article demandant aux utilisateurs de nous suivre sur Twitter.

Copiez et collez simplement le code suivant sous votre bloc d'en-tête de plugin :

<?php function wpb_follow_us($content) { // Only do this when a single post is displayed if ( is_single() ) { // Message you want to display after the post // Add URLs to your own Twitter and Facebook profiles $content .= '<p class="follow-us">If you liked this article, then please follow us on <a href="http://twitter.com/wpbeginner" title="WPBeginner on Twitter" target="_blank" rel="nofollow">Twitter</a> and <a href="https://www.facebook.com/wpbeginner" title="WPBeginner on Facebook" target="_blank" rel="nofollow">Facebook</a>.</p>'; } // Return the content return $content; } // Hook our function to WordPress the_content filter add_filter('the_content', 'wpb_follow_us'); 

N'oubliez pas de remplacer les URL de vos profils Twitter et Facebook par les vôtres avant d'enregistrer vos modifications.

Maintenant, allez sur le bureau de votre ordinateur et créez un fichier zip pour le dossier du plugin.

Les utilisateurs de Mac peuvent faire un clic droit sur le dossier et sélectionner ‘Compresser wpb-plugin-tutorial’. Les utilisateurs de Windows peuvent faire un clic droit sur le dossier et sélectionner ‘Compresser dans un fichier zip’.

Étape 2 : Installer et activer votre premier plugin WordPress

Maintenant que nous avons créé le plugin, il est temps de l'installer afin que vous puissiez le tester. Pour des instructions étape par étape, vous pouvez consulter notre article sur comment installer un plugin WordPress.

Rendez-vous dans la zone d'administration WordPress de votre site web et visitez la page Plugins » Ajouter un nouveau.

Vous devez cliquer sur le bouton « Téléverser un plugin » en haut pour téléverser votre plugin. Cela affichera la boîte de téléversement du plugin.

Cliquez sur le bouton « Choisir un fichier » pour sélectionner le fichier zip que vous venez de créer. Ensuite, cliquez sur le bouton « Installer maintenant » pour téléverser et installer le plugin.

Une fois installé, activez le plugin.

Vous pouvez maintenant visiter votre site web pour voir le plugin en action.

Vous pourrez voir le nouveau paragraphe à la fin de tous vos articles.

Étape 3 : Soumettre votre plugin au dépôt de plugins WordPress.org

Si vous souhaitez que votre plugin soit découvert et utilisé par d'autres utilisateurs WordPress, vous pouvez le soumettre au répertoire de plugins de WordPress.org.

Pour ce faire, vous devrez d'abord créer un fichier « Read Me » pour votre plugin. Ouvrez un fichier texte vierge et enregistrez-le sous le nom readme.txt dans votre dossier de plugin.

Ce fichier readme.txt doit respecter la syntaxe des fichiers readme de WordPress.org. Les informations que vous ajoutez dans le fichier readme.txt seront affichées sur la page de votre plugin sur WordPress.org.

Voici un exemple de fichier readme.txt que vous pouvez utiliser comme point de départ :

=== Your Plugin Name === Contributors: WPBeginner 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. 

Expliquons maintenant un peu comment fonctionne la syntaxe du fichier readme d'un plugin WordPress, afin que vous puissiez le personnaliser pour votre plugin.

La première ligne du fichier readme du plugin est le nom de votre plugin. Ce nom apparaîtra dans l'annuaire des plugins WordPress.org comme titre de votre plugin.

La ligne suivante est Contributeurs. Ce sont les identifiants des utilisateurs responsables de la gestion de votre plugin sur WordPress.org. Si vous n'avez pas encore de compte utilisateur WordPress.org, vous pouvez créer un compte utilisateur WordPress.org gratuit pour obtenir votre identifiant.

'Requires at least' et 'Tested up to' font référence aux versions de WordPress avec lesquelles votre plugin fonctionne. Le 'Stable tag' est la version de votre propre plugin.

Vous pouvez laisser les champs 'License' tels quels, GPL et l'URL identique.

Ensuite, vous pouvez modifier la zone Description pour expliquer ce que fait votre plugin.

Après avoir modifié le fichier readme de votre plugin, n'oubliez pas de sauvegarder vos modifications.

Votre plugin est maintenant prêt à être examiné par l'équipe des plugins de WordPress.org. Pour soumettre votre plugin, vous aurez besoin d'un compte WordPress.org gratuit.

Visitez la page Ajouter votre plugin, et si vous n'êtes pas déjà connecté, cliquez sur le bouton 'veuillez vous connecter'.

Une fois connecté, vous pourrez télécharger et soumettre votre plugin pour examen.

Cliquez simplement sur le bouton 'Sélectionner un fichier' pour choisir le fichier zip de votre plugin. Ensuite, cochez toutes les cases applicables et cliquez sur 'Télécharger'.

L'équipe d'examen des plugins de WordPress.org examinera alors le code de votre plugin pour détecter les erreurs courantes et les vérifications de sécurité. Une fois approuvé, vous recevrez un e-mail de l'équipe des plugins.

Cet e-mail contiendra un lien vers le dépôt Subversion (SVN) de votre plugin hébergé sur WordPress.org.

Étape 4 : Utiliser Subversion (SVN) pour télécharger votre plugin

Subversion est un logiciel de contrôle de version. Il permet aux utilisateurs d'apporter des modifications aux fichiers et aux répertoires tout en conservant un historique des modifications, en gérant différentes versions et en permettant la collaboration.

Vous aurez besoin d'un client SVN installé sur votre ordinateur pour téléverser votre plugin sur WordPress.org.

Les utilisateurs Windows peuvent utiliser SilkSVN ou TortoiseSVN (gratuit). Les utilisateurs Mac peuvent installer SmartSVN ou Versions App sur leurs ordinateurs.

Dans cet article, nous vous montrerons des captures d'écran de l'application Versions pour Mac. Cependant, le processus est très similaire dans toutes les applications SVN avec une interface graphique.

Une fois installé, vous devez ouvrir l'application Versions et extraire une copie du dépôt de votre plugin WordPress. Cliquez simplement sur le bouton « Nouveau signet de dépôt ».

Cela ouvrira une fenêtre contextuelle où, tout d'abord, vous devrez fournir un nom pour ce signet. Vous pouvez le nommer d'après votre plugin.

Après cela, vous devrez ajouter l'URL du dépôt SVN de votre plugin WordPress.

Cliquez sur le bouton « Créer » pour vous connecter à votre dépôt.

L'application Versions téléchargera maintenant une copie du dépôt de votre plugin sur votre ordinateur. Ensuite, faites un clic droit sur le nom de votre dépôt dans la vue du navigateur, puis sélectionnez « Extraire ».

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 plugin et cliquer sur le bouton « Extraire » pour continuer.

L'application Versions créera maintenant une copie locale de votre plugin sur votre ordinateur. Vous pouvez la voir sous le dépôt de votre plugin ou la parcourir à l'aide de l'application Finder.

Vous devez maintenant copier vos fichiers de plugin et les coller dans le dossier trunk de votre dépôt local.

Pendant que vous faites cela, 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 à Subversion, vous êtes prêt à les télécharger. En gros, vous synchroniserez les modifications de votre dossier local et du répertoire Subversion.

Cliquez sur votre dépôt local pour le sélectionner, puis cliquez sur le bouton « Valider ».

Une nouvelle fenêtre contextuelle apparaîtra.

Vous verrez la liste des modifications et une boîte pour ajouter un message de validation. Cliquez simplement sur « Valider » pour continuer.

Votre application SVN synchronisera maintenant vos modifications et les validera dans le dépôt de votre plugin.

Maintenant que vous avez téléchargé vos fichiers de plugin dans le trunk, il est temps de les étiqueter avec une version.

Accédez à la copie locale de votre plugin et copiez les fichiers à l'intérieur du dossier trunk. Ensuite, vous devez ouvrir le dossier tags et, à l'intérieur, créer un nouveau dossier.

Nommez ce dossier d'après un nom de version. Assurez-vous qu'il correspond à la version que vous avez entrée 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 dans le dossier /tags/. Vous remarquerez l'icône du point d'interrogation à côté du nom du dossier dans l'application Version.

Puisqu'il s'agit d'un nouveau dossier, vous devrez cliquer sur le bouton 'Add' pour inclure le dossier et tous ses fichiers dans le dépôt.

Après cela, vous pouvez continuer et cliquer sur le bouton 'Commit' pour synchroniser vos modifications. Vous pouvez continuer à modifier les fichiers de votre plugin dans la copie locale.

Une fois que vous avez terminé vos modifications, cliquez simplement sur le bouton commit pour les synchroniser avec le dépôt WordPress.org.

Si vous avez apporté des modifications majeures à votre plugin, vous voudrez ajouter une nouvelle version en ajoutant un nouveau dossier nommé d'après le numéro de version. Assurez-vous que le numéro de version correspond à l'en-tête de votre plugin.

Vous pouvez maintenant prévisualiser votre plugin dans le répertoire des plugins de WordPress.org.

Étape 5 : Ajouter des illustrations à votre plugin sur WordPress.org

WordPress.org vous permet d'ajouter des illustrations et des captures d'écran à vos plugins. Ces éléments doivent suivre les pratiques de nommage standard et être téléchargés à l'aide de Subversion.

Bannière d'en-tête du plugin

C'est la grande image qui apparaît en haut de la page du plugin. Elle peut faire 772 x 250 ou 1544 x 500 pixels dans les formats de fichier jpeg ou png. Elle doit toujours être nommée comme suit :

• banner-772×250.jpg ou banner-772×250.png
• banner-1544×500.jpg ou banner-1544×500.png

Icône de plugin

Ce fichier image plus petit de forme carrée est affiché comme icône de plugin dans les résultats de recherche et les listes de plugins. Il peut être en 125 x 125 ou 250 x 250 pixels aux formats jpeg ou png.

Ce fichier icône doit être nommé comme suit :

• icon-128×128.jpg ou icon-128×128..png
• icon-256×256.jpg ou icon-256×256.png

Captures d'écran

Les fichiers de capture d'écran doivent être nommés en utilisant le format suivant :

• screenshot-1.png
• screenshot-2.png

Vous pouvez en ajouter autant que vous le souhaitez. Ces captures d'écran doivent apparaître dans le même ordre que les descriptions des captures d'écran dans votre fichier readme.txt.

Une fois que vous avez préparé tous les éléments graphiques, vous pouvez les placer dans le dossier assets de la copie locale de votre plugin.

Après cela, vous remarquerez une icône en point d'interrogation à côté du dossier assets. Cliquez sur le bouton « Ajouter » pour ajouter le nouveau fichier assets à votre dépôt.

Enfin, cliquez sur le bouton commit pour téléverser vos fichiers sur le dépôt WordPress.org. Après un certain temps, vous pourrez voir les éléments graphiques apparaître sur la page de votre plugin.

Guides ultimes pour apprendre le développement de plugins WordPress

Les plugins WordPress peuvent être aussi simples que celui que nous vous avons montré ci-dessus. Ils peuvent également être beaucoup plus puissants, comme des quiz, des minuteurs, des RSVP, des votes, des avis Google, et bien plus encore.

Certains plugins WordPress puissants peuvent également avoir des extensions. Ces extensions fonctionnent comme des plugins qui étendent d'autres plugins.

Voici quelques ressources qui vous aideront à découvrir d'autres façons d'ajouter des fonctionnalités à vos plugins WordPress :

• Extraits de code WordPress utiles pour les débutants
• Ajout d'un shortcode dans WordPress
• astuces pour le fichier functions.php que vous pouvez maintenant utiliser dans un plugin spécifique au site
• Créer des types de publication personnalisés et des taxonomies
• Ajouter correctement des feuilles de style et du JavaScript dans WordPress

Nous espérons que cet article vous a aidé à apprendre comment créer un plugin WordPress. Vous voudrez peut-être aussi consulter notre guide sur comment faire de nouvelles suggestions de fonctionnalités pour WordPress et notre liste des entreprises et sociétés WordPress les plus prospères.

Si cet article vous a plu, abonnez-vous à notre chaîne YouTube pour des tutoriels vidéo WordPress. Vous pouvez également nous retrouver sur Twitter et Facebook.