3.3. Der Kopfbereich

Die einzige Voraussetzung einer Plugin-Datei ist der Kopfbereich (engl. „Header“), der durch einen PHP-Kommentarblock gekennzeichnet wird und einige Infos über das Plugin selbst enthalten muss. Diese Informationen werden „Metadaten“ genannt und werden später über die File-Metadata-API abgerufen. Wie weiter oben bereits angedeutet, lässt sich das Plugin dann schon aktivieren bzw. deaktivieren.

<?php
/*
	Plugin Name: Mein erstes Plugin
*/
?>

Auf Github ansehen

Lediglich der Plugin-Name ist ein Muss. Alle anderen Felder sind optional, sollten aber, falls möglich, dennoch ausgefüllt werden.

Möglich sind folgende Werte, wobei die Anordnung keine Rolle spielt:

  • Plugin Name
  • Plugin URI
    Ein Link auf die Plugin-Seite. In den meisten Fällen ist das ein Link auf die Plugin-Seite bei wordpress.org. Wenn Sie das Plugin nicht kostenlos in der Datenbank bei WordPress anbieten, kann dies natürlich auch jede andere Webseite-URL sein.
  • Description
    Eine Kurzbeschreibung des Plugins in etwa einem Satz.
  • Version
    Die aktuelle Versionsnummer des Plugins. WordPress nutzt diesen Wert, um ihn mit der Version in der WordPress-Plugin-Datenbank abzugleichen. Ist der Wert kleiner als der im Verzeichnis vorhandene, bietet WordPress ein Update an.
  • Author
    Der Name des oder der Plugin-Autoren (ggf. durch Komma getrennt).
  • Author URI
    Ein Link auf eine persönliche Webseite des Autors. Manchmal wird auch nur auf den Twitter-Account oder ähnliche Profile im Web verlinkt. Der Link wird dann mit dem Namen des Autors auf der Plugin-Seite im WordPress Administrationsbereich angezeigt (siehe Abb. 2.1.).
  • License
    Die Kurzform eines Plugin-Lizenzvertrags und dessen Versionsnummer (z.B. GPLv2).
  • Domain Path
    Hier kann der Pfad zur Textdomain angegeben werden. Dieser Wert ist ebenfalls optional und muss nur dann angegeben werden, wenn sich die Sprachdateien (Erkennbar an der Endung *.mo) in einem anderen Pfad befinden. Geben Sie beispielsweise /translations/ als Wert an, wird im Plugin-Unterverzeichnis /translations nach den Dateien gesucht. Wird der Wert nicht angegeben, so wird WordPress ihn automatisch auf den Pfad des Plugin-Verzeichnisses setzen.
  • Network
    Dies ist eine Einstellung, die die Multisite-Funktion von WordPress betrifft. Definieren Sie Network: true, so lässt sich das Plugin nur netzwerkweit aktivieren.
  • Text Domain
    Ein einzigartiger Bezeichner, der für Übersetzungen benutzt wird. WordPress baut aus diesem Bezeichner den Dateienamen der Übersetzungsdatei zusammen. Ich empfehle, den Dateinamen dazu zu benutzen. Befindet sich Ihr Plugin also beispielsweise unter /wp-content/plugins/wp-wetterstation/wp-wetterstation.php, so könnten Sie wp-wetterstation als Text Domain nutzen. Mit diesem Bezeichnet sucht WordPress nun im Pfad, der in Domain Path angegeben wurde, nach der Datei wp-wetterstation-[de_DE].mo. Wobei [de_DE] mit dem jeweils eingestellten Sprachcode ersetzt wird.

Schreiben Sie einen Kommentar