Le code passe-partout en tant que terme est souvent utilisé de manière péjorative car personne ne semble aimer particulièrement l'écrire (y compris les développeurs WordPress). Il fait référence au code qui est répété à de nombreux endroits sans modification comme échafaudage, avant d'écrire du code qui fait réellement quelque chose. Certains langages tels que Java et C++ ont été critiqués pour être comme ça. Mais tout cet échafaudage cependant, est là pour une raison. C'est-à-dire fournir et appliquer de bons principes d'organisation dans la structure du code (Meilleures pratiques).

Dans le contexte des thèmes et plugins WordPress, les avantages de l'utilisation du code passe-partout sont démontrés de manière plus claire et directe. Il existe plusieurs projets WordPress qui fournissent une collection de codes passe-partout bien pensés, qui peuvent vous aider à organiser votre code et à éviter les erreurs.

Qu'est-ce que le code passe-partout ?

Le code standard est essentiellement un squelette de répertoires et de fichiers de code source que vous pouvez utiliser dans le développement de votre projet. Les répertoires aident à organiser les différents fichiers de code source à leur place, et généralement la structure reflète celle de votre plate-forme de développement.

Dans le cas des plugins WordPress, les fichiers de code source contiennent généralement des définitions de fonction d'espace réservé, des valeurs et des commentaires décrivant quelle partie du code va où. Les thèmes WordPress Boilerplate fournissent également une structure de répertoires avec des squelettes js et CSS organisés et annotés.

Avantages du passe-partout dans le développement WordPress

Tous les plugins WordPress ont des fonctions communes telles que l'activation, la désactivation, ainsi que les différents crochets qu'ils doivent implémenter. Un code passe-partout peut fournir une structure commune, qui est bien conçue et applique les bonnes pratiques logicielles. Il y a trois bonnes choses que vous obtenez avec l'utilisation du code passe-partout : une meilleure qualité de code, une maintenance plus facile et un développement plus rapide. Et ceux-ci, à leur tour, font de vous un meilleur développeur WordPress.

Meilleure qualité de code

Bien que la qualité du code du noyau WordPress soit excellente, ce n'est généralement pas le cas avec les plugins WordPress. Une conséquence naturelle de l'utilisation du passe-partout est la normalisation. Des plugins conformes à une norme qui applique les bonnes pratiques, ont un code plus propre et surtout, au bon endroit. Boilerplate encourage également les développeurs à implémenter l'interface et les fonctionnalités du plugin dans son intégralité. En fournissant cet échafaudage, cela vous aide à ne pas laisser quelque chose de côté ou à ne pas l'implémenter mal quelque part.

C'est également une aide précieuse pour les développeurs WordPress débutants car tout est correctement présenté et annoté de commentaires.

Entretien plus facile

Tout ce qui précède conduit à une maintenance plus facile. Le code écrit à l'aide d'un passe-partout est plus facile à lire, à comprendre et à dépanner. Avec la normalisation, un développeur peut prendre votre code et savoir exactement où chercher. Cependant, ce n'est pas seulement pour les autres développeurs WordPress, mais aussi pour vous-même. Un code qui a été écrit il y a une semaine et qui est encore frais dans votre esprit deviendra rapidement incompréhensible quelques mois plus tard.

Développement plus rapide

Le code standard permet également d'accélérer les temps de développement. En vous donnant un squelette de travail complet du projet, il vous permet de commencer à écrire du code et à concevoir aux endroits qui comptent. Vous n'avez pas besoin de passer du temps à organiser le code ou à déterminer les fonctions par défaut ou les composants CSS dont vous avez besoin, puis à les écrire.

Mais le gain le plus important est lorsque vous créez vos propres packages passe-partout plus avancés. Si vous construisez habituellement certains types de sites WordPress, tels que des sites de commerce électronique ou des pages personnelles, la magie opère. Vous pouvez écrire un package avec des fichiers squelettes contenant du code d'espace réservé et des fonctionnalités de thème communes à tous les projets d'un certain type. De cette façon, il vous suffit de décompresser le package et de commencer à le remplir uniquement avec les spécificités du projet.

Hébergez votre site web avec Pressidium

GARANTIE DE REMBOURSEMENT DE 60 JOURS

VOIR NOS FORFAITS

Si vous êtes un client Pressidium, vous pouvez utiliser notre outil de clonage qui a été construit en gardant à l'esprit ce concept simple. Par exemple, imaginons que vous ayez créé un site e-commerce WordPress passe-partout sur la plateforme Pressidium. Vous le clonez en un seul clic, puis vous commencez à travailler sur les détails, au lieu de repartir de zéro à chaque fois.

Utilisation du passe-partout dans les projets WordPress

Il existe plusieurs « systèmes » passe-partout pour WordPress. Mais dans cet article, nous allons nous concentrer sur deux qui sont à la fois bien connus et documentés : Le WordPress Plugin Boilerplate et roots.io.

Le WordPress Plugin Boilerplate se présente comme une «base standardisée, organisée et orientée objet pour la création de plugins WordPress de haute qualité» et il est certainement à la hauteur. Il suit les normes de l'API et de la documentation WordPress, il est construit au-dessus de l'API du plugin WordPress et offre un moyen pratique de localisation. Jetons un coup d'œil à son contenu :

Changelog.md
Il s'agit du fichier Changelog dans Markdown.

plugin-name/
Le dossier principal qui contient tout le reste.

admin/
Toutes les fonctionnalités liées à l'administration sont placées ici. Il comprend trois dossiers pertinents, css , js et partials pour cela.

includes/
Ce répertoire comprend des classes pour la fonctionnalité d'activation/désactivation, la localisation i18n et la classe de chargeur pour définir toutes les fonctions/hooks.

• class-plugin-name-activator.php
• class-plugin-name-deactivator.php
• class-plugin-name-i18n.php
• class-plugin-name-loader.php
• class-plugin-name.php
• index.php

languages/plugin-name.pot
Un fichier standard .pot qui contient les chaînes localisées pour votre plugin.

public/
Ici, vous mettez tout le code de plug-in lié au public. Encore une fois, vous avez les dossiers css , js et partials pertinents.

NOTE : Avant de commencer, n'oubliez pas de renommer toutes les occurrences « plugin-name » avec le nom de votre plugin.

Notre deuxième système passe-partout de choix est beaucoup plus complexe et il n'est donc pas possible de le couvrir dans son intégralité dans cet article. Cependant, il dispose d'une excellente documentation en ligne. Les développeurs ont également écrit une série de livres électroniques pour chaque composant que vous pouvez acheter sur le site officiel !

Roots.io est un système passe-partout avancé offrant trois composants (Trellis, Bedrock et Sage) qui peuvent être utilisés séparément ou conjointement. Il est conçu pour être utilisé pour les projets WordPress et pas seulement pour les plugins ou les thèmes. Il dispose de fonctionnalités avancées telles que le provisionnement de machines virtuelles via Vagrant, la gestion des dépendances avec Composer, la prise en charge de Sass pour l'écriture de feuilles de style, la correction automatique des erreurs Javascript, les tests de navigateur, l'optimisation des images, etc. Il est basé sur le standard HTML5 et est livré avec la dernière version de Bootstrap.

En conclusion

Il existe de nombreux systèmes passe-partout, chacun répondant à des besoins différents. Choisissez Roots.io si vous êtes un développeur WordPress avancé ayant besoin d'une solution complète de projet WordPress ainsi que de fonctionnalités d'intégration et d'une chaîne d'outils. Si vous êtes un développeur WordPress débutant, ou si vous avez juste besoin d'un simple passe-partout pour commencer à développer votre plugin ou votre thème, alors le WordPress Plugin Boilerplate est le plus adapté à vos besoins.