Comment créer une API pour mon plugin?
J'ai développé des plugins pour WordPress, la plupart des plugins que j'ai développés utilisent deux ou trois classes, donc pas aussi énormes que Buddypress ou WooCommerce.
Je prévois de développer deux plugins open source pour fournir une sorte de système complexe (ne pouvant pas partager les détails pour le moment mais plus tard au cours du développement), où d'autres développeurs peuvent personnaliser les fonctions et dont le système doit être identique à Buddypress et WooCommerce. .
Au fur et à mesure que je vérifie ces fichiers de plugins et que je réalise qu'ils ont enregistré leurs propres actions et filtres, les développeurs peuvent les modifier selon leurs besoins. Cependant, mon problème est de ne pas comprendre complètement comment je devrais écrire un plugin où les autres ont la possibilité de remplacer des fonctions et d’ajouter les leurs.
Je sais qu'il est difficile de donner une réponse définitive, mais j'ai besoin d'une sorte de guide de démarrage pour pouvoir aller dans la bonne direction. Dois-je enregistrer mes propres actions et filtres? Si oui comment? sinon alors, quelles sont mes options?
Votre conseil m'aidera beaucoup ... Merci
L'API que vous proposez dans un plugin ou un thème dépend de la logique de ce code spécifique. Il n'y a probablement pas de guide qui s'applique à toutes les situations.
Je suis un contributeur pour plusieurs plugins avec API, et ce que j'ai appris jusqu'à présent, c'est:
Ne proposez pas une API tant que vous ne savez pas vraiment comment les utilisateurs utilisent votre code.
Libérez les deux ou trois premières versions sans aucune API. Pas d'actions personnalisées ou de filtres, pas de méthodes ou de fonctions publiques (et jamais de variables globales) si possible. Attendez les demandes de vos utilisateurs, mais n’ajoutez pas le code avant de savoir que votre structure de code interne fonctionnera à long terme.
Il est difficile de maintenir la compatibilité avec les versions antérieures d'une API . Cela pourrait empêcher des améliorations nécessaires ailleurs. Pensez à toutes les variables globales que WordPress ne peut pas supprimer de nos jours. C’est une mauvaise API, et nous en sommes restés fidèles pendant de nombreuses années, parce que les gens utilisent déjà .
Pensez à séparer votre API du reste du code (voir le lien précédent pour une idée).
Votre API devrait être utile non seulement aux développeurs tiers, mais également à vous. N'ajoutez pas de restriction pour vous-même si vous n'y êtes pas obligé.Mangez votre propre nourriture pour chien.
Si vous proposez des hooks personnalisés, utilisez-les dans votre code. Cela donnera aux autres développeurs des exemples utiles, et vous pourrez voir assez tôt les failles possibles.
Si le noyau de WordPress utilisait la soi-disant API de paramètres en interne, nous n’aurions pas ce gâchis aujourd’hui. Peut être.Mener par l'exemple.
Utilisez les bonnes parties de l’API de base WordPress dans votre plugin. Évitez les objets anonymes } _, les constantes, les variables globales et tout type de code imprévisible .Assurez-vous que vous utilisez un schéma de dénomination cohérent (pas comme un gâchis ), et mettez tout sous votre propre espace de nommage.
Écrivez la documentation en premier. Libérer une nouvelle (partie d'une) API ultérieurement.
Créez des exemples utiles pour tout. Vous serez surpris de voir combien de trous et de redondances vous allez trouver.Évitez de rappeler l'enfer.
Proposez des outils spécifiques pour déboguer votre API lorsque les choses ne fonctionnent pas correctement (y compris des scripts et des feuilles de style non spécifiés). J'ai écrit un exemple pour savoir comment déboguer AJAX , juste pour illustrer à quel point vous pouvez être créatif ici. Encore une fois, ces outils doivent être expliqués dans votre documentation avant de les publier.Une alternative au paradigme de rappel de WordPress pourrait être le modèle observateur . Cela soulèverait la barrière pour les développeurs tiers, mais cela pourrait conduire à un meilleur code des deux côtés.