Wie bereits im Kapitel über die Coding Standards angedeutet: Sie sind kein Muss. Genauso wenig, wie die nachfolgenden Datei- und Ordnerstruktur, die ich Ihnen ans Herz legen möchte. Die empfohlene Struktur soll Ihnen jedoch dabei helfen, den Code sauber, nachvollziehbar und strukturiert zu gestalten.
Ich selbst habe schon sehr viele Strukturen ausprobiert: eine Herangehensweise, die nur Funktionen nutzt und welche, die nur objektorientiert arbeiten. In beiden Fällen ist und war es immer von Vorteil, eine gewisse Ordnerstruktur zu haben.
Das bedeutet zuerst einmal: Im Plugin-Ordner selbst sollten sich nur drei Dateien befinden:
- Die primäre Plugin-Datei, die von WordPress gesucht, gefunden und ausgeführt wird,
- eine mögliche
uninstall.php-Datei und - die
readme.txt, die genauere Informationen zum Plugin sowie eine kurze Beschreibung, eine FAQ oder ähnliches enthält.
Alle anderen Dateien sollten in separat dafür vorgesehenen Ordnern abgelegt werden. Ein Beispiel:
- /mein-plugin/
- mein-plugin.php
- (uninstall.php)
- readme.txt
- /assets
- /js – JavaScript-Dateien
- /css – CSS-Dateien
- /images – Bilder
- /languages – Sprachdateien
- /includes (oder /classes) – einzelne PHP-Dateien
Aus Performancegründen sollten Sie bestimmte Bestandteile Ihres Plugins in einzelne PHP-Dateien auslagern, anstatt den gesamten Code in eine einzelne Datei zu schreiben. Beispielsweise lassen sich mit
<?php
if( is_admin() ){
require_once( "meine-zusaetzliche-datei.php" );
}
?>
nur Dateien laden, die im Backend-Bereich von WordPress nötig sind.