Kategorien
Content Management Systeme Programmieren Shared Hosting

Hello Dolly oder wie schreibe ich ein WordPress Plugin?

Wenn du jemals WordPress installiert hast, so bist du sicherlich auch schon einmal über das Hello Dolly Plugin „gestolpert“. Seit dem Jahr 2012 und der WordPress Version 2.7.1 wird das Hello Dolly Plugin standardmässig in jedem neuen WordPress installiert. Es zeigt nach der Aktivierung im Zufallsprinzip rechts im Administrationsbereich Textzeilen aus dem Liedtext von „Hello, Dolly“ an.

Das sieht dann so aus:

Textzeile aus Hello Dolly im Dashboard
Textzeile aus Hello Dolly im Dashboard

Nun stellt sich natürlich die Frage … Warum?

Einerseits sicherlich um die Freude der Core Entwickler an der Musik zu dokumentieren denn jede Major WordPress Version wird nach einem Jazz Musiker benannt.

Andererseits ist Hello Dolly auch ein gutes Beispiel, wie einfach es ist ein WordPress Plugin zu schreiben.

Hello Dolly Plugin

Das Plugin besteht aus einer PHP-Datei mit den PHP-Anweisungen (hello.php), einer Text-Datei (readme.txt) mit Beschreibungen und, je nach installierter Sprache, den Übersetzungsdateien hello-dolly-de_DE.mo und hello-dolly-de_DE.mo.

Das ist der Inhalt der Text-Datei (readme.txt):

=== Hello Dolly ===
Contributors: matt, wordpressdotorg
Stable tag: 1.7.2
Tested up to: 5.8
Requires at least: 4.6

This is not just a plugin, it symbolizes the hope and enthusiasm of an entire generation summed up in two words sung most famously by Louis Armstrong.

== Description ==

This is not just a plugin, it symbolizes the hope and enthusiasm of an entire generation summed up in two words sung most famously by Louis Armstrong: Hello, Dolly. When activated you will randomly see a lyric from <cite>Hello, Dolly</cite> in the upper right of your admin screen on every page.

Thanks to Sanjib Ahmad for the artwork.

Die beiden Dateien (hello.php und readme.txt) liegen in einem Verzeichnis /wp-content/plugins/hello-dolly um sie von den Dateien der anderen Plugins abzugrenzen. Alle Plugins befinden sich im Unterverzeichnis /wp-content/plugins.

Hello Dolly Plugin im Datei-Manager

Die beiden Sprachdateien befinden sich im Unterverzeichnis /wp-content/languages, sind aber für das Funktionieren des Plugins zunächst nicht notwendig. Sie werden erst interessant wenn die englischen Texte, die im Quellcode benutzt werden, in eine andere Sprache übersetzt werden sollen. Auch die readme.txt Datei dient nur der besseren Übersicht für Entwickler:innen und hat keinen Einfluss auf den eigentlichen Programmcode. Entscheidend für die Funktion ist die PHP-Datei hello.php. Sie ist 100 Zeilen lang. Alle Texte innerhalb des Quellcodes werden in englischer Sprache erstellt.

Der nächste Screenshot stammt aus dem Dateimanager unseres Verwaltungstools cPanel und zeigt die PHP-Funktionen in hello.php.

hello.php mit eingeklappten Codebereichen

Der rot hinterlegte PHP-Befehl function definiert eine neue Funktion, in unserem Fall hello_dolly_get_lyric(), hello_dolly() und dolly_css(). Die Bezeichnungen deuten schon auf die Aufgabe der Funktionen hin:

  • hello_dolly_get_lyric() – Hole eine Textzeile aus der Menge aller Textzeilen
  • hello_dolly() – schreibe die gewählte Textzeile ins Dashboard
  • dolly_css() – Ein wenig CSS zur Positionierung

Die Funktion add_action ist im WordPress Core enthalten und wird in Plugins verwendet um „etwas“ zum existierenden WordPress hinzuzufügen. In unserem Fall nutzen wir die Parameter admin_notices um eine Nachricht in den Adminbereich (Dashboard) zu schicken und admin_head um das gewünschte CSS an die richtige Stelle zu bekommen. Es gibt zahlreiche add_action Parameter und es ist wichtig, bzw. wirklich sehr hilfreich, zu erforschen welche Parameter zur Verfügung stehen. Ausser der Funktion add_action gibt es hunderte weiterer Funktionen, die du „einfach so“ in deinem Plugin benutzen kannst. Ein WordPress Plugin nutzt im Idealfall sehr viele dieser WordPress Core Funktionen. Sie sind millionenfach erprobt und meistens immer sicherer als eigener Code.

Du kannst die Anweisungen im Hello Dolly verändern, musst aber beachten, dass deine Änderungen bei einem evtl. Update überschrieben werden. Daher ist es eine gute Idee, das Plugin zu kopieren, umzubenennen und dann eigene Änderungen einzubauen.

Als Beispiel sei hier das Hello Dalai Plugin genannt, das Zitate vom Dalai Lama anzeigt oder das Hello Force Plugin, dass Zitate aus Star Wars anzeigt.

Fazit

Das Hello Dolly Programm ist eine Art Hello World Programm für WordPress. Der Quellcode ist ausführlich kommentiert und es ist ein guter Start um die Funktionsweise von Plugins besser zu verstehen und eigene Programmierversuche zu starten.

Link

Auf WordPress.org findet sich das Plugin Developer Handbook. Es ist der perfekte Start!

Welcome to the WordPress Plugin Developer Handbook; are you ready to jump right in to the world of WordPress plugins?

https://developer.wordpress.org/plugins/

tl;dr: Hello Dolly ist oft der Beginn einer interessanten Reise durch die WordPress Welt


Von hagengraf

Ich erstelle bequeme und benutzerfreundliche Orte in virtuellen und physischen Umgebungen.

Schreibe einen Kommentar

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