WordPress Plugins übersetzen mit gettext, po und pot Dateien

Es gibt eine Reihe von Beschreibungen zum Thema „WordPress Plugins übersetzen mit gettext, po und pot Dateien“. Hätte ich das gewusst als ich anfing ein Plugin zu entwickeln, dann hätte ich es gleich mit gettext, dem wordpress codex entsprechend umgesetzt. Da ich diese Kenntnisse nicht hatte, habe ich mir selbst beholfen und einfach alle Übersetzungen in einem Array abgelegt und je nach ausgewählter Sprache, das Array mit den richtigen Übersetzungen gefüllt. Das sieht dann beispielsweise so aus:

function set_translation($LANGUAGE)
{
    $tl=array();
    // Translated Labels
    $tl['time'] = "time";
    ....
    if ($LANGUAGE=="de")
    {
        // Translated Labels
        $tl['time'] = "Zeit";
        ....
    }
    return $tl;
}Code-Sprache: PHP (php)

Die Funktion set_translation wird einfach mit dem Ländercode aufgerufen und schon erhält man ein array mit den gewünschten Übersetzungen. Um die Übersetzung aufzurufen verwendet man einfach

echo $tl['time'];

Ein solches Konstrukt auf die gettext Vorgehensweise anzupassen macht ein bisschen Arbeit. Aber immerhin hinterher, ist es einfacher zu pflegen, da man einen der verfügbaren gettext Editoren verwenden kann (z.B. poedit) und es ist der Standard. Aber vor allem soll es schneller sein (wirklich verifiziert habe ich das noch nicht).

WordPress Plugins übersetzen mit gettext

WordPress sieht für die Übersetzung von Programmteilen zwei Funktionen vor, die _e() und die __() Funktion. Die Erstgenannte gibt den übersetzten Text direkt aus (e = echo) und die zweitgenannte liefert den übersetzten Text zur weiteren Verwendung als String zurück. Beide Funktionen erlauben neben dem ersten Parameter für den eigentlichen Text, einen zweiten Parameter zur Angabe der Textdomain, so eine Art separater Bereich oder Klasse von Übersetzungen für einen bestimmten Programmteil (oder ein Plugin). Durch die Textdomain kann man ausschließen, andere Übersetzungen zu überschreiben oder selbst überschrieben zu werden.

So sieht das dann aus:

$a = __("time","meinedomain"); echo $a;
_e("time","meinedomain");Code-Sprache: PHP (php)

Beide Zeilen bewirken übrigens das Gleiche.

Um aus den mit den Funktionen _e und __ arbeitenden PHP Dateien eine POT Datei (also ein Template für die Übersetzung) zu erzeugen, bedient man sich des Programms xgettext.

Der Aufruf

xgettext -L PHP -k --keyword=_e  --keyword=__ --from-code=latin1 --default-domain=meineDomain --output=meinTemplate.pot *.phpCode-Sprache: JavaScript (javascript)

generiert das Template.

Zur Pflege der Übersetzungen kopiert man am einfachsten das Template in eine Datei mit dem jeweiligen ISO-Code der gewünschten Sprache, z.B. de_DE.po für deutsch oder sv_SE.po für Schwedisch.

Diese Datei editiert man mit einem gettext Katalog Editor, wie oben erwähnt verwende ich poedit.

In einem letzten Schritt wandelt man jetzt diese Textdatei in einen binären gettext Katalog.

Dies geschieht mit dem Befehl msgfmt. Beispielsweise:

msgfmt  -o de_DE.mo de_DE.poCode-Sprache: CSS (css)

Wer jetzt schon mal ausprobiert, ob es funktioniert wird feststellen, das der Katalog noch nicht herangezogen wird und daher noch gar nichts übersetzt wird. Dazu muss man WordPress noch mitteilen, das der Katalog zu laden ist. WordPress bietet dafür die Funktion load_plugin_textdomain(‚mydomain‘) an. Der Parameter ‚mydomain‘ gibt den in den _e() und __() Funktionen verwendeten Domänennamen an. Nach dieser Anpassung sollte es dann auch mit der Übersetzung klappen.

Noch zwei Tipps:

Es soll vorkommen, dass man ein Plugin weiterentwickelt und sich damit auch der Umfang der zu übersetzenden Texte verändert.
Das gettext Paket hat auch hierfür eine Lösung. Mit dem Programm msgmerge kann man ein neues Template (.pot) und eine vorhandene Übersetzung (.po) zusammenführen und das ohne bereits übersetzte Texte zu verlieren.
Der Aufruf

msgmerge -U de_DE.po myinplugin.potCode-Sprache: CSS (css)

ergänzt die .po Datei um noch nicht vorhandene Texte.

Wenn man wie ich zunächst mit einer Array Variante gearbeitet hat, so wäre es ehr mühsam alle Textstellen händisch von $tl[…] auf __(…) anzupassen. Es kommen schnell dreistellige Anzahlen von Textstellen zusammen und dieser Weg wäre sehr mühsam.
Um sich zumindest 99% der Arbeit zu sparen, kann man sich des sed und regulärer Ausdrücke bedienen.

cat myplugin.php | sed 's/$tl\[\(.*\)\]/__(\1,\'\mydomain')/g'Code-Sprache: JavaScript (javascript)

Der sed sucht (s/) nach den Stellen an denen $tl[…] vorkommt und ersetzt diese durch __(…). Die Angabe \1 verwendet den durch \( \) eingegrenzten Teil des Ausdruckes. Ist eher etwas für den fortgeschrittenen Linuxer. Eine gute Dokumentation zu sed findet man unter http://www.nt-nv.fh-koeln.de/pits/regex.html.

Ich hoffe es hilft dem ein oder anderen beim WordPress Plugins übersetzen mit gettext.