Documentation · Documentation développeur

Structure du dépôt

Cette page fournit une orientation publique et sécurisée du dépôt de l'extension. Un inventaire complet des fichiers et des classes, une carte des espaces de noms et une description module par module sont gérés en tant que documentation interne et ne sont pas publiés ici.

Orientation

Au niveau supérieur, le dépôt contient le fichier d'entrée PHP principal de l'extension, ses ressources d'administration et de modèles, ses traductions intégrées, un répertoire tests/ utilisé par l'intégration continue propre au projet, et l'ensemble de la documentation publique que vous lisez actuellement sous docs/.

Pour les contributeurs qui ont besoin d'un environnement de développement fonctionnel, consultez la Configuration du développement local. Pour les conventions de codage, consultez les Normes de codage.

Surfaces d'intégration publiques prises en charge

Lors de l'intégration avec l'extension, privilégiez ces surfaces stables :

Les noms de classes internes, les clés d'option, les tables de base de données, les points de terminaison REST et AJAX, les noms de hooks cron, les identifiants de capacités et de nonces, ainsi que l'infrastructure de publication / mise à jour sont traités comme des détails d'implémentation. Ils peuvent changer d'une version à l'autre sans préavis et ne font pas partie du contrat d'intégration publique.

Politique de stabilité et de modification

Tout ce qui n'est pas répertorié comme une surface publique prise en charge ci-dessus est considéré comme un détail d'implémentation interne. Les API internes, la structure de stockage et l'implémentation de la sécurité peuvent changer d'une version à l'autre. Ne dépendez pas d'eux à partir de codes tiers, de thèmes ou de systèmes externes. Les écritures directes dans la base de données ne sont pas prises en charge.

Avis de documentation publique. Cette page fournit uniquement un aperçu d'intégration de haut niveau. Les détails d'implémentation interne, les API privées, les aspects internes du stockage et l'infrastructure de publication sensible à la sécurité sont gérés séparément et ne font pas partie de la documentation publique. Les surfaces d'intégration prises en charge sont les shortcodes documentés, les surcharges de modèles, l'interface utilisateur des réglages et tous les points d'extension explicitement publiés dans cette section.