Écrire un plugin WordPress simple, tutoriel pour débutant

En langage simple, un plugin WordPress est un programme simple qui vous aide à personnaliser et à améliorer votre site Web WordPress sans avoir à modifier la programmation de base. Quand vous maîtrisez Développement de plugins WordPress, vous pourrez ajouter toutes sortes de fonctionnalités à votre blog WordPress en un rien de temps. Mais avant de devenir un pro, vous devez apprendre les cordes.


Un plugin WordPress est un programme, ou un ensemble d’une ou plusieurs fonctions, écrit dans le langage de script PHP, qui ajoute un ensemble spécifique de fonctionnalités ou de services au blog WordPress, qui peut être intégré de manière transparente au blog en utilisant des points d’accès et des méthodes fourni par l’API WordPress Plugin Application Program Interface. – Rédaction d’un plugin, WordPress Codex

Dans l’article d’aujourd’hui, nous vous guiderons à travers le processus de création de votre premier plugin WordPress. Nous garderons le tutoriel simple pour répondre aux besoins des développeurs débutants qui ont peu ou pas de connaissances PHP (le langage de script derrière WordPress).

Avant de passer au codage réel, cependant, nous examinerons quelques choses que vous devez comprendre sur le développement de plugins WordPress.

Bases à savoir avant de créer un plugin WordPress

Dans cette section, nous dévoilerons premières étapes vous devez suivre lors de la création d’un plugin WordPress. De plus, nous mentionnerons toutes les différentes choses que vous devez prendre en considération lors de l’écriture de votre plugin. Génial. Commençons par les bases.

Comment nommer un plugin WordPress

Avant tout le reste, vous devez trouver un nom unique pour votre plugin WordPress. L’une des meilleures façons de déterminer un nom favorable est de penser à ce que fera votre plugin. Ainsi, par exemple, si votre plugin aidera les gens à partager du contenu via les médias sociaux, vous pouvez inclure l’expression «partage de médias sociaux» dans le nom. Une autre chose, les noms des plugins peuvent être plusieurs mots, alors ne mâchez pas la créativité.

Le nom de votre plugin doit être unique pour éviter les conflits avec d’autres plugins. Pour vous assurer que votre nom est unique, vous pouvez effectuer une recherche Google sur le nom. De plus, vous pouvez rechercher les différents répertoires de plug-ins, y compris Référentiel de plugins WordPress.

Pour nommer n’importe quel plugin, nous devons créer au moins un fichier de plugin (le fichier PHP principal), qui nous introduit à notre prochaine section.

Comment créer des fichiers de plugin

Un plugin peut être composé d’un seul fichier PHP ou de plusieurs fichiers selon ce qu’il est conçu pour faire. Le fichier le plus important est le principal Fichier PHP, qui est l’équivalent de index.php et index.html dans les thèmes WordPress et les conceptions HTML respectivement.

Il est recommandé aux développeurs WordPress de nommer leur fichier de plugin principal d’après leur plugin par convention. Par exemple, le fichier de plugin principal pour un plugin appelé WP Renym plugin serait wp-renym.php. Si vous ajoutez un séparateur à votre nom, utilisez uniquement des tirets (-) entre les mots plutôt que des traits de soulignement (_).

Comme mentionné ci-dessus, un plugin peut être constitué d’un ou de plusieurs fichiers (images, JavaScript, langue, fichiers CSS, etc.). Quoi qu’il en soit, vos fichiers de plug-in doivent vivre dans un seul répertoire. Donc, pour un plugin nommé WP Renym, le wp-renym.php fichier serait placé dans un wp-renym dossier. Des sous-dossiers supplémentaires peuvent être ajoutés dans le dossier principal du plugin pour contenir et organiser d’autres fichiers.

Après avoir défini tout le code d’un plugin, vous compressez ensuite votre dossier principal dans un fichier zip (dans ce cas, ce serait l’archive wp-renym.zip) à télécharger et à installer sur un site WordPress.

Ajout d’un en-tête de fichier au fichier PHP principal

Lorsque vous nommez votre plugin, vous devez ajouter d’autres détails tels que la description, la version, la licence, le nom de l’auteur – essentiellement tout ce qui apparaîtra sous et à côté de votre plugin dans le Écran des plugins WordPress – l’en-tête du plugin. Pour cela, vous devez utiliser un en-tête d’informations de plugin standard en haut de votre fichier PHP principal. Voici à quoi ressemble un en-tête typique:


/ *
Nom du plugin: nom de votre plugin
URI du plugin: http: // lien vers la page d'accueil de votre plugin
Description: décrivez en quoi consiste votre plugin en quelques phrases courtes
Version: 1.0
Auteur: Votre nom (Yay! Voici la gloire ...)
URI de l'auteur: http: // lien vers votre site Web
Licence: GPL2 etc.
URI de licence: http: // lien vers votre licence de plugin
* /

Chaque paramètre dans l’en-tête ci-dessus est explicite, donc je n’entrerai pas dans les détails. Assurez-vous simplement d’inclure les informations pertinentes http: // ou https: // lors de l’écriture de vos URI de plugin et d’auteur ou les liens ne fonctionneront pas.

Suivez votre en-tête avec les informations de licence suivantes si vous utilisez un Licence GPL2 ou une licence compatible avec la GPL2:

/ * Copyright YEAR PLUGIN_AUTHOR_NAME (email: votre adresse email)
(Plugin Name) est un logiciel gratuit: vous pouvez le redistribuer et / ou le modifier
sous les termes de la GNU General Public License telle que publiée par
la Free Software Foundation, soit la version 2 de la licence, soit
toute version ultérieure.

(Nom du plugin) est distribué dans l'espoir qu'il sera utile,
mais SANS AUCUNE GARANTIE; sans même la garantie implicite de
QUALITÉ MARCHANDE ou ADÉQUATION À UN USAGE PARTICULIER. Voir le
Licence publique générale GNU pour plus de détails.

Vous devriez avoir reçu une copie de la licence publique générale GNU
avec (Nom du plugin). Sinon, voir (http: // lien vers votre licence de plugin).
* /

La portée de ce didacticiel ne nous permet pas d’aller au-delà de ces étapes de base. Vous devrez vérifier le écrire un plugin guide dans le codex pour en savoir plus sur les crochets de plugins WordPress, les balises de modèle, l’enregistrement des données de plugins dans des bases de données, le mécanisme des options de plugins et la mise à jour de votre plugin, entre autres. Le codex comprend également un énorme Ressources de plugin collection pleine de guides vidéo, de sujets avancés et plus encore.

Maintenant que nous avons couvert les bases, écrivons un simple plugin WordPress qui exécutera deux fonctions de base (mais astucieuses):

  • Remplacez les mots de votre contenu par votre propre choix de mots
  • Ajoutez une note «Merci d’avoir lu ce tutoriel…» à la fin de chaque article de blog.

Comment écrire un plugin WordPress simple – WP Renym

Dans cette section, nous allons écrire du code pour le plugin WP Renym que j’ai mentionné tout au long.

De quoi as-tu besoin:

Nommer notre plugin

Tout d’abord, nous avons vérifié le référentiel de plugins WordPress et fait une recherche Google sur notre nom; WP Renym était gratuit. Mon choix initial était WP Rename mais il a déjà été pris.

Pour continuer… Ouvrez un nouveau fichier dans votre éditeur de code, et ajoutez le code suivant en haut après avoir ouvert votre plugin avec :

/ *
Nom du plugin: WP Renym
URI du plugin: http: // lien vers la page d'accueil de votre plugin
Description: ce plugin remplace les mots par votre propre choix de mots.
Version: 1.0
Auteur: Freddy Muriuki
URI de l'auteur: http: // lien vers votre site Web
Licence: GPL2 etc.
URI de licence: https: // lien vers votre licence de plugin

Copyright YEAR PLUGIN_AUTHOR_NAME (e-mail: votre adresse e-mail)
(Plugin Name) est un logiciel gratuit: vous pouvez le redistribuer et / ou le modifier
sous les termes de la GNU General Public License telle que publiée par
la Free Software Foundation, soit la version 2 de la licence, soit
toute version ultérieure.

(Nom du plugin) est distribué dans l'espoir qu'il sera utile,
mais SANS AUCUNE GARANTIE; sans même la garantie implicite de
QUALITÉ MARCHANDE ou ADÉQUATION À UN USAGE PARTICULIER. Voir le
Licence publique générale GNU pour plus de détails.

Vous devriez avoir reçu une copie de la licence publique générale GNU
avec (Nom du plugin). Sinon, voir (http: // lien vers votre licence de plugin).
* /

Enregistrez le fichier sous wp-renym.php dans le dossier wp-renym. Si vous n’avez pas déjà le dossier, créez-le. wp-renym.php sera votre fichier PHP principal.

Ajout de fonctions

Maintenant, pour ajouter les fonctions réelles au plugin. Juste en dessous du code ci-dessus, ajoutez la fonction suivante pour corriger les fautes d’orthographe de wordpress à WordPress:

fonction renym_wordpress_typo_fix ($ text) {
return str_replace ('wordpress', 'WordPress', $ text);
}
add_filter ('the_content', 'renym_wordpress_typo_fix');

renym_wordpress_typo_fix est le nom unique que nous avons donné à notre fonction. Lorsque vous ajoutez de nouvelles fonctions, ne commencez jamais par wp_ – ceci pour éviter toute future incompatibilité avec les fonctions de code WordPress qui utilisent toutes le préfixe wp_.

Notre fonction PHP prend ($ text) comme argument et retourne la 1ère chaîne ‘wordpress’ remplacée par la 2ème chaîne ‘WordPress’.

Nous avons ajouté un filtre (add_filter) à notre plugin pour indiquer notre fonction ( renym_wordpress_typo_fix ) pour travailler sur le texte que nous avons sélectionné, qui dans ce cas est le contenu complet du post (le_contenu).

Pour remplacer plus d’un mot (vous voudrez peut-être modifier plusieurs mots sur votre blog ou utiliser le plug-in comme simple filtre de blasphème), remplacez le code ci-dessus par le code suivant:

fonction renym_content_replace ($ content) {
$ search = array ('wordpress', 'goat', 'Easter', '70', 'sensationnel');
$ replace = array ('WordPress', 'café', 'Vacances de Pâques', 'soixante-dix', 'extraordinaire');
return str_replace ($ search, $ replace, $ content);
}
add_filter ('the_content', 'renym_content_replace');

Dans notre code ci-dessus, nous avons déjà sélectionné les mots à remplacer, par exemple wordpress, chèvre, Pâques, etc. Nous avons également sélectionné les mots de remplacement, par ex. WordPress, café, vacances de Pâques, etc. J’espère que le code est assez explicite:

  • le renym_content_replace La fonction prend ($ content) comme argument, remplace tous les mots contenus dans le tableau $ search et renvoie les mots maintenant modifiés à WordPress.
  • $ search contient tous les mots à remplacer
  • $ replace contient les mots de remplacement
  • str_replace fait ce qu’il fait le mieux, en remplaçant les mots par les nouveaux mots

Notez comment nous ajoutons le préfixe renym à chaque fonction. Cela évite les conflits avec d’autres plugins qui pourraient être installés. Vous devriez prendre l’habitude d’ajouter des préfixes à vos fonctions, que vous développiez des plugins, des thèmes ou des widgets.

Si vous avez terminé les étapes ci-dessus, votre plug-in peut remplacer efficacement tous les mots sélectionnés. Ajoutons maintenant la note «Merci d’avoir lu ce tutoriel…» qui apparaîtra au bas de chaque article. Ajoutez le code suivant à votre fichier de plugin principal ( renym_content_replace ) avant le crochet de fermeture PHP ( ?> ) Qui vient à la dernière ligne:

fonction renym_content_footer_note ($ content) {
$ content. = '
Merci d'avoir lu ce tutoriel. Peut-être que la prochaine fois je vous laisserai m'acheter un café! Pour plus de tutoriels WordPress, visitez notre blog
» renvoyer $ content; } add_filter ('the_content', 'renym_content_footer_note');

Enregistrez les modifications. le renym_content_footer_note ajoute le balisage HTML au paramètre $ content et renvoie la nouvelle valeur à WordPress. Nous avons également ajouté une classe de pied de page à notre texte afin qu’il puisse être facilement stylisé plus tard..

Nous avons inclus un filtre (add_filter) qui indique à notre fonction de fonctionner sur le texte que nous avons sélectionné, qui est le contenu du message tel que représenté par le_contenu.

Compressez votre dossier

À ce stade, votre finale wp-renym.php le fichier devrait ressembler à ceci:

Merci d'avoir lu ce tutoriel. Peut-être que la prochaine fois je vous laisserai m'acheter un café! Pour plus de tutoriels WordPress, visitez notre blog»
renvoyer $ content;
}
add_filter ('the_content', 'renym_content_footer_note');

?>

Enregistrez toutes vos modifications. Compressez le dossier WP Renym dans un wp-renym.zip archive (sur un Mac, c’est aussi simple que de faire un clic droit, compresser un fichier – et sur PC, je pense que c’est très similaire). Assurez-vous simplement que votre fichier est enregistré en tant qu’extension .ZIP ou que le plug-in ne sera pas installé.

Utilisez votre plugin

Téléchargez et activez votre nouveau plugin WP Renym via le Écran des plugins WordPress. Félicitations pour avoir écrit votre premier plugin!

Installez le plugin Renym WordPress

Ressources

Pour en savoir plus sur le développement de plugins WordPress, veuillez consulter les ressources suivantes:

Conclusion

J’espère que ce tutoriel vous a orienté dans la bonne direction en ce qui concerne la compréhension des plugins. Ce message devrait servir de tremplin pour développer des plugins WordPress complexes qui font tout ce que vous voulez. Ne vous arrêtez pas ici, consultez les ressources que j’ai recommandées ci-dessus pour approfondir vos connaissances sur le développement de plugins WordPress.

Si vous avez trouvé ce didacticiel utile ou si vous avez autre chose à ajouter, nous aimerions le savoir. Partagez vos idées dans la section des commentaires ci-dessous. A bientôt ��

Jeffrey Wilson Administrator
Sorry! The Author has not filled his profile.
follow me