En langage profane, 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 tu maîtrises Développement de plugin 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 ficelles du métier.

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 à l’aide de points d’accès et de méthodes. fourni par l’interface de programme d’application du plugin WordPress (API). – Ecrire 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 didacticiel simple pour répondre aux besoins des développeurs débutants qui ont peu ou pas de connaissances sur 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.

Principes de base à connaître avant de créer un plugin WordPress

Dans cette section, nous allons révéler le quelques premiers pas 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 compte lorsque vous écrivez votre plugin. Génial. Commençons par les bases.

Comment nommer un plugin WordPress

Avant tout, vous devez trouver un nom unique pour votre plugin WordPress. L’un des meilleurs moyens de déterminer un nom favorable est de penser à ce que fera votre plugin. Ainsi, par exemple, si votre plugin aide les gens à partager du contenu via les réseaux sociaux, vous pouvez inclure l’expression «partage sur les réseaux sociaux» dans le nom. Autre chose, les noms de plugins peuvent être composés de 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 plugins, y compris le Dépôt de plugins WordPress.

Pour nommer un plugin, nous devons créer au moins un fichier de plugin (le fichier PHP principal), ce qui nous présente notre section suivante.

Comment créer des fichiers de plug-in

Un plugin peut être composé d’un seul fichier PHP ou de plusieurs fichiers en fonction de ce pour quoi il est conçu. Le fichier le plus important est le fichier 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 après leur plugin par convention. Par exemple, le fichier de plugin principal pour un plugin appelé plugin WP Renym serait wp-renym.php. Si vous ajoutez un séparateur dans 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, langage, fichiers CSS, etc.). Dans tous les cas, 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 votre dossier principal dans un fichier zip (dans ce cas, il s’agirait d’une 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 sur le plugin standard en haut de votre fichier PHP principal. Voici à quoi ressemble un en-tête typique:


/*
Plugin Name: Name of your plugin
Plugin URI:  http://link to your plugin homepage
Description: Describe what your plugin is all about in a few short sentences
Version:     1.0
Author:      Your name (Yay! Here comes fame... )
Author URI:  http://link to your website
License:     GPL2 etc
License URI: http://link to your plugin license
*/

Chaque paramètre de l’en-tête ci-dessus est explicite, je n’entrerai donc pas dans les détails. Assurez-vous simplement d’inclure les http: // ou https: // lors de l’écriture de vos URI Plugin et 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 : your email address)
(Plugin Name) is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
(Plugin Name) is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with (Plugin Name). If not, see (http://link to your plugin license).
*/

La portée de ce tutoriel 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 hooks de plug-in WordPress, les balises de modèle, l’enregistrement des données du plug-in dans les bases de données, le mécanisme d’options du plug-in et la mise à jour de votre plug-in, entre autres. Le codex comprend également un énorme Ressources du plugin collection qui regorge de guides vidéo, de sujets avancés et plus encore.

Maintenant que nous avons couvert les bases, écrivons un plugin WordPress simple 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 effectué une recherche Google sur notre nom; WP Renym était gratuit. Mon choix initial était WP Rename mais il était déjà pris.

Passer à autre chose… Ouvrez un nouveau fichier dans votre éditeur de code, et ajoutez le code suivant en haut après avoir ouvert votre plugin avec php:

/*
Plugin Name: WP Renym
Plugin URI:  http://link to your plugin homepage
Description: This plugin replaces words with your own choice of words.
Version:     1.0
Author:      Freddy Muriuki
Author URI:  http://link to your website
License:     GPL2 etc
License URI: https://link to your plugin license

Copyright YEAR PLUGIN_AUTHOR_NAME (email : your email address)
(Plugin Name) is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
(Plugin Name) is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with (Plugin Name). If not, see (http://link to your plugin license).
*/

Enregistrez le fichier sous wp-renym.php dans le dossier wp-renym. Si vous ne disposez pas déjà du 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:

function 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 les lancez jamais avec wp_ – ceci pour éviter de futures incompatibilités avec les fonctions de code WordPress qui utilisent toutes le préfixe wp_.

Notre fonction PHP prend ($ text) comme argument et renvoie 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 l’intégralité du contenu de l’article (the_content).

Pour remplacer plus d’un mot (peut-être souhaitez-vous modifier plusieurs mots sur votre blog ou utiliser le plugin comme un simple filtre de grossièretés), remplacez le code ci-dessus par le code suivant:

function renym_content_replace( $content ) {
    $search  = array( 'wordpress', 'goat', 'Easter', '70', 'sensational' );
    $replace = array( 'WordPress', 'coffee', 'Easter holidays', 'seventy', 'extraordinary' );
    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 exemple WordPress, café, vacances de Pâques, etc. J’espère que le code est assez explicite:

  • le renym_content_replace function 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 de 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 plugin peut remplacer efficacement tous vos mots sélectionnés. Ajoutons maintenant la note «Merci d’avoir lu ce tutoriel…» qui apparaîtra au bas de chaque message. Ajoutez le code suivant à votre fichier de plugin principal ( renym_content_replace ) avant le crochet PHP de fermeture ( ?> ) qui vient dans la dernière ligne:

function renym_content_footer_note( $content ) {
    $content .= '<footer class="renym-content-footer">Thank you for reading this tutorial. Maybe next time I will let you buy me a coffee! For more WordPress tutorials visit our <a href="http://wpexplorer.com/blog" title="Themelocal Blog">Blog</a></footer>';
    return $content;
}
add_filter( 'the_content', 'renym_content_footer_note' );

Enregistrez les modifications. le renym_content_footer_note La fonction 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 d’opérer sur le texte que nous avons sélectionné, qui est le contenu de l’article représenté par the_content.

Compressez votre dossier

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

<?php
/*
Plugin Name: WP Renym
Plugin URI:  http://link to your plugin homepage
Description: This plugin replaces words with your own choice of words.
Version:     1.0
Author:      Freddy Muriuki
Author URI:  http://link to your website
License:     GPL2 etc
License URI: https://link to your plugin license

Copyright YEAR PLUGIN_AUTHOR_NAME (email : your email address)
(Plugin Name) is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
(Plugin Name) is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with (Plugin Name). If not, see (http://link to your plugin license).
*/

/*Use this function to replace a single word*/
function renym_wordpress_typo_fix( $text ) {
    return str_replace( 'wordpress', 'WordPress', $text );
}
add_filter( 'the_content', 'renym_wordpress_typo_fix' );

/*Or use this function to replace multiple words or phrases at once*/
function renym_content_replace( $content ) {
    $search  = array( 'wordpress', 'goat', 'Easter', '70', 'sensational' );
    $replace = array( 'WordPress', 'coffee', 'Easter holidays', 'seventy', 'extraordinary' );
    return str_replace( $search, $replace, $content );
}
add_filter( 'the_content', 'renym_content_replace' );

/*Use this function to add a note at the end of your content*/
function renym_content_footer_note( $content ) {
    $content .= '<footer class="renym-content-footer">Thank you for reading this tutorial. Maybe next time I will let you buy me a coffee! For more WordPress tutorials visit our <a href="http://wpexplorer.com/blog" title="Themelocal Blog">Blog</a></footer>';
    return $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 qu’un clic droit, compresser le fichier – et sur PC, je crois que c’est très similaire). Assurez-vous simplement que votre fichier est enregistré en tant qu’extension .ZIP, sinon le plugin ne s’installera pas.

Utilisez votre plugin

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

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. Cet article 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 augmenter vos connaissances sur le développement de plugins WordPress.

Si vous avez trouvé ce tutoriel 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 🙂

Share: