Code-Referenz à la developer.wordpress.org erstellen

In der Code-Referenz unter developer.wordpress.org/reference lassen sich alle Funktionen, Hooks, Klassen und Methoden von WordPress finden. Bei einem Eintrag für eine Funktion wird dann beispielsweise angezeigt, welche Parameter sie erwartet, welchen Rückgabewert es gibt und wie der Code aussieht. Hier beschreibe ich kurz, wie sich etwas ähnliches umsetzen lässt.

Vor einiger Zeit bin ich auf die Idee gekommen, für meine Themes eine Code-Referenz bereitzustellen, die ähnliche Infos bereitstellt, wie die offizielle von WordPress (das Ergebnis könnt ihr hier am Beispiel des Photographus-Themes sehen). Das entsprechende Plugin WP-Parser, das den Code von WordPress für die Code-Referenz durchsucht und daraus Custom-Post-Types (CPTs) erstellt, liegt auf GitHub und ist nicht besonders schwer einzusetzen. Vorausgesetzt wird neben PHP 5.4+ noch Composer und WP-CLI.

Nachdem das Plugin installiert und aktiviert wurde, kann es mit folgendem Befehl ausgeführt werden:

wp parser create /path/to/source/code --user=<id|login>

Dadurch werden die Dateien und Inline-Dokumentation geparsed und entsprechende CPT-Einträge (es gibt die CPTs FunctionsMethodsClasses und Hooks) angelegt.

Für die Ausgabe im Frontend sorgt das Plugin natürlich nicht. Sehr nützlich dafür ist der Code des Themes, das für developer.wordpress.org genutzt wird (vor allem die Funktionen in inc/template-tags.php) – den Code könnt ihr via SVN beziehen.

Ein kleines Problem gibt es mit dem Plugin allerdings: wenn ihr aktualisierten Code neu parsen möchtet, werden die bestehenden Beiträge nicht aktualisiert, sondern neue angelegt. Um das Problem zu lösen, lösche ich vor dem Neu-Parsen alle alten Beiträge (nicht gerade elegant, aber es funktioniert).

Das könnte auch interessant sein

Schreib einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.