Composer-Plugin für WordPress-Übersetzungen

Wer WordPress-Plugins oder -Themes entwickelt, hat sicher das Thema Internationalisierung bzw. Lokalisierung auf dem Schirm. Die __() und _e()-Aufrufe im Code sind schnell geschrieben, aber der Weg zu den übersetzten Strings und schliesslich zur fertigen Übersetzung ist oft etwas steiniger. Ich hatte irgendwann keine Lust mehr, jedes Mal WP-CLI-Befehle nachzuschlagen, die dann in der entsprechenden Reihenfolge auszuführen und dabei zu hoffen, dass ich nichts vergessen habe.

Ausgaben des Composer-Plugins "composer-i18n-scripts" im Terminal.

Zu viele Schritte, zu wenig Automatisierung

Der i18n-Workflow in WordPress sieht im Kern so aus: Man scannt den Quellcode nach übersetzbaren Strings, erzeugt eine .pot-Vorlage, leitet daraus .po-Dateien für die einzelnen Sprachen ab, kompiliert die in .mo-Dateien. Wenn man Block-Themes oder JavaScript-basierte Blöcke hat, braucht man zusätzlich .json-Dateien für die Script-Translations.

WP-CLI bringt dafür den wp i18n-Befehl mit, der all das kann. In der Praxis heißt das aber: Man hat entweder ein Shell-Skript irgendwo im Repo liegen (welches von niemandem gepflegt wird), oder man tippt die Befehle jedes Mal von Hand. Oder – was mir auch schon passiert ist – man macht es „irgendwann“ und merkt dann, dass die Übersetzungen seit drei Releases nicht mehr aktuell sind.

Das Fundament: wp-cli/i18n-command

Das wp-cli/i18n-command ist Teil von WP-CLI und stellt die wp i18n-Befehle: make-pot, make-json, make-mo, make-php, update-po bereit. Es ist ein ausgereiftes, von zahlreichen Unterstützern gepflegtes Projekt. Es bietet alles, was man für den WordPress-i18n-Workflow braucht: vom PHP-String-Scanning über Blade-Templates bis hin zu block.json– und theme.json-Extraktion.

Die Befehle selbst sind mächtig und flexibel: make-pot allein hat über ein Dutzend Optionen für Includes, Excludes, Header-Anpassungen und mehr. Genau das macht sie aber auch im Alltag etwas sperrig. Man muss sich bei jedem Aufruf erinnern, welche Flags man für das jeweilige Projekt braucht, und die Befehle in der richtigen Reihenfolge verketten.

Die Idee: Composer als Schaltzentrale

Composer ist in vielen modernen WordPress-Projekten ohnehin an Bord. Und Composer kann mehr als nur Pakete installieren. Über die Plugin-API lassen sich eigene Befehle registrieren, die sich nahtlos in den bestehenden Workflow einfügen. Genau dafür gibt es composer-i18n-scripts: die bewährten wp i18n-Befehle werden als Composer-Commands verfügbar gemacht. Die Arbeit wird weiterhin von wp-cli/i18n-command erledigt, mein Plugin reduziert den mentalen Overhead.

Statt sich zu merken, wie der WP-CLI-Aufruf genau lautet und welche Flags man braucht, reicht jetzt:

composer i18n:make-pot
composer i18n:update-po
composer i18n:make-json
composer i18n:make-mo

Das Plugin liest die nötigen Metadaten – wie Text Domain und Domain Path – direkt aus den Plugin- oder Theme-Headern. Man muss also nichts konfigurieren, wenn die Standards eingehalten werden.

Was steckt im Composer-Plugin?

Das Plugin registriert sechs Befehle:

i18n:make-potScannt den Quellcode und erzeugt die .pot-Vorlage.
i18n:create-po <locale>Erstellt aus der Vorlage eine neue .po-Datei für eine Sprache, z. B. de_DE.
i18n:update-poAktualisiert alle vorhandenen .po-Dateien mit neuen Strings aus der .pot.
i18n:make-moKompiliert alle .po-Dateien in binäre .mo-Dateien.
i18n:make-phpExportiert Übersetzungen als PHP-Arrays, was in manchen Setups performanter ist.
i18n:make-json Erzeugt die JSON-Übersetzungsdateien für JavaScript/Block-Editor-Translations.

Unter der Haube ist das Ganze ein echtes Composer-Plugin (Typ composer-plugin), das die Composer Plugin API ab Version 2.6 nutzt und WP-CLI als Abhängigkeit mitbringt. Es wird automatisch registriert: kein Bootstrap-Code, kein manuelles Aktivieren.

Ausprobieren

Das Plugin ist auf Packagist verfügbar und lässt sich in jedem WordPress-Plugin- oder Theme-Projekt als Dev-Abhängigkeit installieren:

composer require --dev lloc/composer-i18n-scripts

Die Voraussetzungen sind PHP 7.4+ und Composer 2.6+. Das Repository mit dem vollständigen Quellcode und der Dokumentation befindet sich auf GitHub: lloc/composer-i18n-scripts.

Wenn du Feedback hast oder einen Bug findest, sind Issues und Pull Requests natürlich absolut willkommen.

Autor: realloc

Software Developer & WordPress Enthusiast | Born in Germany. Reborn in Italy.

Schreibe einen Kommentar

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

Your post must include a link to this post.

How does this work?
Write a response on your own website and include a link to this post. Then submit your response’s URL here. Your response may appear here after moderation. To update or remove it, edit or delete your original post and submit the same URL again. Learn more about Webmentions.