Dokumentation · Entwickler-Dokumentation
Repository-Struktur
Diese Seite bietet eine öffentlich zugängliche Orientierung über das Repository des Plugins. Ein vollständiges Datei- und Klassenverzeichnis, eine Namespace-Map sowie eine modulweise Beschreibung werden als interne Dokumentation gepflegt und hier nicht veröffentlicht.
Orientierung
Auf der obersten Ebene enthält das Repository die Haupt-PHP-Einstiegsdatei des Plugins, seine Admin- und Template-Assets, seine gebündelten Übersetzungen, ein Verzeichnis tests/, das von der projekt-eigenen kontinuierlichen Integration (CI) verwendet wird, und die öffentliche Dokumentation, die Sie gerade lesen, unter docs/.
Für Mitwirkende, die eine funktionierende Entwicklungsumgebung benötigen, siehe Ersteinrichtung der lokalen Entwicklung. Für Codierungsrichtlinien siehe Coding Standards.
Unterstützte öffentliche Integrationsschnittstellen
Wenn Sie eine Integration mit dem Plugin vornehmen, bevorzugen Sie diese stabilen Schnittstellen:
- Die Admin-Einstellungen-Benutzeroberfläche des Plugins.
- Die dokumentierten Shortcodes.
- Template-Overrides auf Theme-Ebene, wie in Template-System und Overrides beschrieben.
- Die allgemeine Entwickler-Übersicht zur Orientierung.
Interne Klassennamen, Option-Keys, Datenbanktabellen, REST- und AJAX-Endpunkte, Cron-Hook-Namen, Berechtigungs- und Nonce-Identifikatoren sowie die Release- und Update-Infrastruktur werden als Implementierungsdetails behandelt. Sie können sich zwischen den Versionen ohne vorherige Ankündigung ändern und sind nicht Teil des öffentlichen Integrationsvertrags.
Stabilitäts- und Änderungsrichtlinie
Alles, was oben nicht als unterstützte öffentliche Schnittstelle aufgeführt ist, gilt als internes Implementierungsdetail. Interne APIs, das Speicherlayout und Sicherheitsimplementierungen können sich zwischen den Versionen ändern. Verlassen Sie sich nicht auf diese in Code von Drittanbietern, Themes oder externen Systemen. Direkte Schreibzugriffe auf die Datenbank werden nicht unterstützt.
Hinweis zur öffentlichen Dokumentation. Diese Seite bietet nur einen allgemeinen Überblick über die Integration. Interne Implementierungsdetails, private APIs, Speicherinterna und sicherheitsrelevante Release-Infrastrukturen werden separat gepflegt und sind nicht Teil der öffentlichen Dokumentation. Unterstützte Integrationsschnittstellen sind die dokumentierten Shortcodes, Template-Overrides, die Einstellungs-Benutzeroberfläche und alle in diesem Abschnitt explizit veröffentlichten Erweiterungspunkte.