Guide du débutant pour le développement de plugins WordPress

Le CMS WordPress a changé le visage de notre Internet et a permis une vague de nouvelles idées de prospérer et son mouvement open source détient une forte présence enracinée dans le développement logiciel et web. WordPress est une plate-forme de blogging capable de se lancer dans de nombreux autres scripts tels que des forums Web, des sites d'emploi et même une page Web classique. Système de gestion de contenu.

Nous allons passer en revue plusieurs manières de se lancer dans le développement de plug-ins pour WordPress. Les étapes sont assez simples et n'exigent pas un grand dévouement pour étudier. Une connaissance rudimentaire de PHP serait utile même avec une compréhension de base de la structure de fichier WordPress et du panneau d'administration.

Dans ce bref tutoriel, nous allons passer en revue les étapes de base requises pour créer un plug-in WordPress simple. La fonctionnalité sera utilisée pour créer des extraits dynamiques en fonction du nombre transmis à notre appel de fonction. Vous devez télécharger le fichier de plug-in et l'activer à partir du panneau d'administration, puis faire un suivi en appelant notre service à partir des pages souhaitées pour lesquelles l'extrait doit s'afficher. Des liens vers le code source du plug-in terminé sont déjà ajoutés plus tard dans cet article :)

Pourquoi développer pour WordPress?

Les plug-ins constituent un excellent moyen d'améliorer les fonctionnalités de votre blog en ajoutant des fonctionnalités supplémentaires. Ceux-ci peuvent être placés n'importe où dans votre modèle par des crochets de fonction. Au fil du temps, l'extensibilité du système de plug-in de WordPress a permis une croissance considérable et des centaines de logiciels soumis par les développeurs..

WordPress offre spécifiquement dans son système de gestion de contenu de telles fonctionnalités avancées que les plug-ins uniques sont rares. En tant que développeur, vous détenez un contrôle total sur les spécificités de votre blog. Embaucher un développeur PHP pour créer un plugin système coûterait beaucoup plus cher que vous ne le pensez et l'API est assez facile à utiliser et à apprendre par vous-même..

En guise d'argument secondaire, développer sur WordPress est une excellente pratique pour vous adapter à d'autres domaines. La création de plugins et de widgets de barre latérale plus petits dans WordPress vous aidera à mieux comprendre le fonctionnement réel du système dorsal. Cela ne se limite pas à WordPress, car vous comprendrez mieux la grande majorité des systèmes de contenu..

1. Structure du dossier WP

Une introduction à la structure de dossiers WordPress montrera les répertoires d'application de base. Dans wp-content, vous trouverez un plugins annuaire. C'est ici que tous vos plug-ins individuels seront hébergés, qu'il s'agisse de fichiers uniques ou de sous-répertoires correctement nommés..

Pour les plug-ins plus petits ne nécessitant qu'un seul fichier .php, vous avez la possibilité de le placer directement dans le répertoire plug-ins /. Cependant, lorsque vous commencez à développer des applications plus complexes, il est bien plus utile de créer un sous-répertoire nommé d'après votre plug-in. À l'intérieur, vous pouvez héberger du code JavaScript, CSS et HTML, ainsi que vos fonctions PHP..

UNE readme.txt Ce fichier peut également être utile si vous envisagez de télécharger votre plugin. Ce fichier doit inclure votre nom et le rôle du plugin. En tant qu’auteur, vous pouvez également inclure des détails sur chaque révision et les mises à jour publiées..

2. Démarrer votre fichier PHP

Lorsque vous créez un nouveau plugin, vous devez commencer par un simple fichier PHP. Cela peut être nommé n'importe quoi, mais doit généralement refléter le nom officiel de votre plug-in. Ainsi, par exemple, j'ai créé notre code de base et nommé mon fichier hongkiat-excerpt.phps.

Les premières lignes de votre plug-in doit être des informations de commentaire pour le moteur d'analyse. Ceci est extrêmement important car WordPress ne pourra pas traiter votre fichier sans. Vous trouverez ci-dessous un exemple de code que vous pouvez copier et modeler vers votre propre.

Le nom du plug-in est ce qui apparaîtra dans votre panneau d'administration dorsal lorsque vous activerez. Identique à l'URI qui sera placé dans le volet d'informations à l'intérieur du panneau des plug-ins. Bien qu'il ne soit pas nécessaire d'inclure une version ou une description, votre plugin aura un aspect beaucoup plus professionnel..

3. Conventions de nommage WordPress et meilleures pratiques

Il existe plusieurs façons de structurer votre plug-in. Plusieurs fois, les développeurs PHP créeront un système de classes complet afin d'éviter les conflits avec les fonctions et les noms de variables. Si vous ne connaissez pas les fonctionnalités avancées de programmation orientée objet de PHP, il est préférable d'écrire votre code dans des exemples de fonctions..

Donc, pour notre exemple de code, nous écrirons une seule fonction pour héberger nos données. Nous devons également définir quelques variables qui sont essentielles à mettre en œuvre dans nos fichiers de modèle. Vous trouverez ci-dessous un exemple de code extrait de notre fichier de plug-in avec la logique de base supprimée..

Lors de la rédaction de votre exemple de code, il est préférable de suivre les réglementations et les guides mis en place par WordPress. Comme il y a tant de fonctions internes déjà définies, vous pouvez éviter les doublons en préfixant une étiquette à toutes vos variables et noms de fonctions.

Dans les exemples ci-dessus, nous avons préfixé tous nos noms de paramètres avec hongkiat. Cela peut être remplacé par n'importe quel mot clé de votre choix, généralement lié au nom de votre plugin. Le code ci-dessus est juste paramètres de l'échantillon et ne devrait pas appartenir à notre dernier plug-in. Ceci est juste pour vous donner un aperçu de la façon dont vos noms de variable et appels de fonction doivent être écrits.

4. Plonger dans les filtres et les actions

Il convient de mentionner un autre concept avant de passer à notre code brut.. actes et filtres sont deux concepts complètement différents qui se rapportent profondément à la manière dont ils manipulent les données de plug-in.

Ces deux bits de code sont standard dans l’API WordPress. Les filtres et les actions permettent aux développeurs de plug-ins de mettre à jour des éléments de code dans le panneau d'administration WordPress relatif à votre nouveau plug-in. Cela signifie que vous pouvez ajouter un nouvel onglet dans la barre latérale ou des liens de paramètres supplémentaires pour vos options de plug-in..

Comprendre add_filter ()

UNE filtre est utilisé sur un morceau de texte ou de données transmis à WordPress. Avec les filtres, vous êtes littéralement capable de filtrer le contenu à travers vos propres fonctions écrites personnalisées pour modifier les données de quelque manière que ce soit.

Par exemple, vous pouvez créer un filtre pour changer $ the_content qui est une variable définie par WordPress contenant l'intégralité du contenu d'un article WordPress. Pour notre plug-in, nous allons prendre $ the_content et raccourcir la longueur des caractères dans un extrait.

Les filtres sont utiles lorsque vous écrivez des plug-ins pour personnaliser l'apparence de votre blog. Celles-ci sont particulièrement populaires lors de l'écriture de widgets de la barre latérale ou de fonctions plus petites pour modifier le mode d'affichage d'un message. Vous trouverez ci-dessous un exemple de ligne de code montrant comment appliquer un filtre..

add_filter ('wp_title', 'hongkiat_func');

Ici, nous ajoutons un filtre dans le titre de la page WordPress. Notez que ce code ne se rapporte pas à notre plugin officiel et n’est utilisé ici qu’à titre d’exemple..

le add_filter Cette fonction est native de WordPress et permet d’ajouter un nouveau filtre à une variable trouvée dans le contenu de la page. Dans la ligne ci-dessus, nous ciblons $ wp_title qui contient le titre de notre page actuelle. Nous passons ensuite cette variable dans une fausse fonction intitulée hongkiat_func () qui pourrait ensuite manipuler et renvoyer une nouvelle balise de titre à des fins quelconques.

Comprendre add_action ()

Les actions sont similaires aux filtres en ce sens qu'elles ne fonctionnent pas sur des bits de données, mais ciblent des zones prédéfinies dans vos modèles et votre panneau d'administration. Par exemple, vous pouvez appliquer une action chaque fois que vous mettez à jour ou modifiez le contenu d'une page. WordPress propose une liste complète d'actions dans la documentation de leurs API. Vous trouverez ci-dessous une petite liste d’exemples d’actions pour vous permettre de vous familiariser avec certaines des zones cibles prédéfinies..

publier_post - appelé quand un article est publié ou quand le statut est changé en “publié”
save_post - appelé quand un article / une page est créé depuis le début ou est mis à jour
wp_head - appelé lorsque le modèle est chargé et exécute le wp_head () une fonction
loop_end - appelé immédiatement après le traitement du message final par la boucle WordPress
trackback_post - appelé à chaque fois qu'un nouveau trackback est ajouté dans un post

Encore une fois, nous pouvons voir à quel point ce bout de code est simple. Si vous pouvez comprendre la différence entre les actions et les filtres, vous serez beaucoup plus près de la création de plugins WordPress complets et fonctionnels. Ci-dessous, une autre ligne de code initialisant une fonction d’action sur le save_post crochet. Pour clarifier, cela ne fait pas partie de notre plugin de développement actuel et n’est utilisé que comme exemple de code pour comprendre la add_action () une fonction.

add_action ('save_post', 'notify');

Nous voyons donc ici une configuration similaire à celle d’avant avec add_filter (). Nous avons besoin de 2 variables, la première contient le nom de notre hook que nous ciblons. Dans ce cas save_post ce qui signifie que chaque fois qu'une nouvelle publication est enregistrée, nous allons appeler notre fonction définie dans la deuxième position (notifier ()). Vous pouvez évidemment mettre à jour notify avec le nom de la fonction que vous souhaitez exécuter, mais cela n'est pas nécessaire pour notre exemple de plug-in actuel..

Finition de notre logique de plugin

En terminant sur notre chemin, nous allons ajouter notre fonction finale directement dans notre fichier de plug-in. La documentation de l'API est très spécifique et constitue une excellente ressource pour les développeurs pouvant poser des questions avancées. Le matériel peut sembler difficile si vous n'êtes pas familier avec PHP mais prenez votre temps avec les concepts et les choses commenceront à couler naturellement!

La fonction ci-dessous devrait être ajoutée directement après le commentaire d'en-tête de votre plugin. Alternativement cela pourrait aussi être placé dans votre thème functions.php fichier. Le code est utilisé pour créer un contenu de publication dynamique basé sur une plage de caractères limitée..

Donc, pour notre exemple, nous pouvons limiter les extraits d’histoire à 55 caractères hk_trim_content () une fonction. Vous pouvez facilement appeler ce morceau de code à partir d'un widget de la barre latérale ou de l'un de vos fichiers de thème pour le remplacer. $ the_content.

= $ limite) array_pop ($ content); $ content = implode ("", $ content). '…';  else $ content = implode ("", $ content);  $ content = preg_replace ('/\[.+\]/', ", $ content); $ content = apply_filters ('the_content', $ content); retourne $ contenu;?>

Il ne faut pas s’attendre à ce que vous compreniez parfaitement toutes les variables ou fonctions internes utilisées ici. Comprendre simplement comment vos fonctions devraient être écrites et à quoi ressemblerait un exemple serait un très bon début.

Vous remarquerez peut-être aussi que nous utilisons un appel vers apply_filters qui est une autre fonction spécifique à WordPress. C’est un autre aspect que vous n’avez pas besoin de bien comprendre, mais cela facilite la programmation future sur WP. Consultez la page de référence apply_filters pour plus de détails et de FAQ sur le sujet..

La fonction principale ci-dessus est nommée hk_trim_content (). Cela nécessite seulement 1 paramètre nommé limite de $. Cela pourrait aussi être réduit à $ lim qui devrait stocker un entier spécifiant le nombre de caractères pour limiter votre extrait. Le contenu est utilisé sur des pages d'articles complètes et également des pages statiques (à propos de nous, contactez).

Par conséquent, pour appeler cette fonction, nous devons ajouter le paramètre dans nos fichiers de modèle. Ce serait placé quelque part éventuellement dans votre index.php ou loop.php fichier (s) et vous devrez d’abord installer le plugin. Exemple ci-dessous:

Installer et exécuter le plugin

J'ai créé un exemple de fichier pour le plug-in à tester si vous souhaitez ignorer le codage en dur. Il suffit de télécharger ce fichier (le renommer en .php) ou de copier / coller le code dans un nouveau document PHP et de le télécharger sur votre / wp-content / plugins annuaire.

Une fois terminé, vous voudrez accéder au panneau d'administration WordPress et parcourir votre ensemble actuel de plug-ins pour la démonstration qui vient d'être installée. Une fois que vous activez rien de nouveau ne se produira, pas jusqu'à ce que nous ajoutions manuellement dans notre appel de fonction. Pour ce faire, il suffit de naviguer Apparence -> Éditeur et chercher single.php.

Ce fichier contient tous les modèles HTML / CSS pour votre page d'article de base. Faites défiler jusqu'à trouver le contenu() et remplacez par l'exemple de code ci-dessus. Cela limitera toutes les pages de vos articles à 55 caractères, quelle que soit la vue utilisée. Vous pouvez également ajouter dans cette fonction des pages similaires dans votre répertoire de modèles, telles que search.php ou archive.php.

Conclusion

Voici quelques-uns des principes de base pour commencer à travailler dans le développement WordPress. Le système de plugins est vaste et contient beaucoup de fonctionnalités internes. Si vous avez déjà une idée pour un plug-in, essayez-le sur une installation locale de WordPress pour vous entraîner à ces sujets..

Si beaucoup d’informations vous échappent, vous pouvez consulter la documentation WordPress et rechercher votre réponse à cet endroit. La communauté de développement est pleine d'utilisateurs utiles et les forums contiennent des archives avec des questions de nombreuses années en arrière.