L'API des paramètres WordPress, partie 1 qu'est-ce que c'est, pourquoi est-ce important?

Comme nous l'avons mentionné à plusieurs reprises ici sur WP Tuts (et comme vous l'avez sans doute remarqué), il n'y a jamais eu de meilleur moment pour devenir développeur WordPress. Que ce soit le travail client ou le développement de produits (avec des thèmes ou des plugins), se lancer dans l'écosystème WordPress est presque davantage une question de «où» que de «comment».

WordPress propose une documentation stellaire sur les API pour les développeurs, quel que soit leur niveau d'expérience. Mais une communauté de développement active et une API bien documentée ne rendent pas une plate-forme à l'abri de mauvaises pratiques de développement..

Comme pour la plupart des aspects du développement Web, le fait que quelque chose fonctionne ne veut pas dire qu'il a été construit de la bonne manière. Mais en tant que développeurs et artisans, nous avons pour tâche de nous assurer que le travail que nous publions fonctionne correctement et est construit correctement. L'analyse du code source pour une variété de thèmes ou de plugins montre que les développeurs publient des produits qui fonctionnent mais qui ne sont pas architecturés de la meilleure façon possible. Cela est particulièrement vrai dans les domaines des options de thème, des pages de menu, de la validation, etc..

Et nous voulons arrêter ça.

Dans cette série, nous allons nous plonger dans l'API Paramètres WordPress. Nous allons voir ce que c'est, pourquoi c'est important et comment en tirer parti dans notre travail.

Notre objectif ultime est de faire de cette série une référence solide pour l’API de configuration. indépendamment de votre niveau d'expérience. À la fin, vous devriez avoir une compréhension claire de l’API et des exemples concrets de la façon de faire les choses correctement..

Pour être complet, nous devons commencer à zéro. Donc, avant d'écrire un code ou de travailler avec des exemples, nous devons introduire l'API Settings, ce que c'est et pourquoi c'est important.


Les paramètres définis par l'API

Au niveau le plus élémentaire, l’API de paramètres est un ensemble de fonctions fournies par WordPress qui simplifie le processus d’introduction de menus, de pages d’options, ainsi que la sauvegarde, la validation et la récupération des entrées d’utilisateur..

Assez facile, à droite?

Tout au long de cette série, nous aborderons chaque aspect, mais cela devrait fournir une définition simple sur laquelle nous pourrons travailler dans le reste des articles..

Pourquoi devrions-nous utiliser l'API Settings?

Maintenant que nous comprenons ce que fait réellement l’API Paramètres est, nous devons examiner pourquoi nous souhaitons utiliser cette option plutôt que de gérer nous-mêmes les saisies, la sérialisation et la validation des utilisateurs..

Communique avec WordPress Core

L'API de configuration est fournie par les développeurs de la plate-forme WordPress afin de faciliter l'extension de l'application. En tant que tel, ne serait-il pas logique d'utiliser les fonctions fournies par les auteurs de la plateforme elle-même??

Bien sûr, il est tout à fait possible de contourner ces fonctions et de "forcer" notre propre fonctionnalité et personne d'autre ne peut réellement l'arrêter, mais cela nécessite un travail inutile de notre part, ignore les recommandations de l'équipe de WordPress Core et risque de rompre l'expérience cohésive. du tableau de bord.

Choisir de tirer parti des fonctionnalités fournies pour développeurs par les développeurs s'assurent que nous communiquerons correctement avec l'application principale.

Trucs gratuits hors de la boîte

L'utilisation de l'API Settings ne consiste pas uniquement à s'assurer que le développement est abordé via les canaux recommandés. Il s'agit également de veiller à ce que nos interfaces utilisateur respectent les meilleures pratiques de la plateforme et à ce que nos données soient purifiées à l'aide des mêmes mécanismes que ceux utilisés par le reste de WordPress. Cela ne fait pas de mal que cela puisse nous faire gagner beaucoup de temps, soit.

Lorsque vous commencez à créer vos interfaces de manière à ce qu'elles exploitent les styles WordPress existants et à l'aide de l'API Settings, votre travail sera beaucoup plus étroitement intégré au reste du système..

Cela signifie que lorsque les utilisateurs commencent à utiliser votre travail, ils ne se sentent plus comme s'ils utilisaient un utilitaire tiers lorsqu'ils travaillent avec leur blog. Au lieu de cela, ils travaillent avec une amélioration (par opposition, par exemple, un ajout) à la plate-forme principale.

Certes, l’utilisation de styles WordPress natifs n’est pas une partie intégrante de l’API Paramètres, c’est un peu une perspective subjective, mais certains aspects de l’API Paramètres - tels que l’introduction de pages de menu - exploitent les styles WordPress natifs. N’est-il donc pas logique que le reste de votre travail fasse de même??

Plus sûr, plus résilient

En tirant parti des fonctions natives de WordPress plutôt que des vôtres, vous pouvez être assuré que la sauvegarde, la récupération et la validation des paramètres sont correctement gérées. Après tout, l’API de paramètres fournit la plupart des fonctionnalités sur lesquelles repose l’application principale..

De plus, les paramètres de l'API sont soumis aux mêmes règles que le reste de l'API WordPress. Ainsi, lorsque l'application est mise à jour et / ou que des modifications sont introduites, les fonctions devront passer par le processus de dépréciation habituel. Cela vous laisse suffisamment de temps pour mettre à niveau votre projet avant les ruptures de compatibilité. Ce n'est pas nécessairement le cas si vous voulez lancer votre propre fonctionnalité.

Feuille de route à venir

À ce stade, vous devez avoir une idée précise de ce qu'est l'API des paramètres et des raisons pour laquelle vous devriez l'utiliser dans le travail sur les thèmes et les plug-ins..

Bien sûr, tout cela est un peu argumentatif - nous n’avons pas encore examiné d’exemples concrets. Dans le reste de cette série, nous examinerons les éléments suivants:

  • Menus, sections et navigation par onglets
  • Enregistrement des paramètres de sections
  • Éléments primitifs (entrées, zones de texte, sélections, boutons d'option et cases à cocher)
  • Un exemple simple et fonctionnel

À la fin de la série, vous devriez avoir tout ce dont vous avez besoin pour commencer à créer de solides produits WordPress.