WordPress Plugin ent­wi­ckeln – So pro­gram­miert man ein eigenes Plugin

Das beliebte Content-Ma­nage­ment-System WordPress zeichnet sich unter anderem durch seine Mo­di­fi­zier­bar­keit aus. So können diverse Plugins in­stal­liert werden, um den Funk­ti­ons­um­fang des CMS zu erweitern. Für eine noch bessere Anpassung an Ihre eigenen Be­dürf­nis­se können Sie außerdem eigene WordPress-Plugins ent­wi­ckeln.

Vorteile eines eigenen WordPress-Plugins

An­ge­sichts der zahl­rei­chen Er­wei­te­run­gen, die wie WordPress selbst größ­ten­teils kos­ten­frei sind und im Plugin-Ver­zeich­nis der of­fi­zi­el­len Website zum Download be­reit­ste­hen, scheint es nicht wirklich notwendig zu sein, ein eigenes WordPress-Plugin zu erstellen. Auf der Suche nach den ge­eig­ne­ten Er­wei­te­run­gen für Ihr Web­pro­jekt werden Sie al­ler­dings schnell fest­stel­len, dass viele Plugins (hier haben wir für Sie die besten WordPress-Plugins vor­ge­stellt) zwar Ihren Such­kri­te­ri­en ent­spre­chen mögen, aber entweder …

• nicht mehr wei­ter­ent­wi­ckelt werden,
• nicht mehr bzw. nicht wie gewünscht funk­tio­nie­ren
• oder nicht über den er­for­der­li­chen Funk­ti­ons­um­fang verfügen.

Sich mit der WordPress-Pro­gram­mie­rung zu be­schäf­ti­gen und ein eigenes Plugin zu erstellen oder ein vor­han­de­nes für die eigenen Zwecke um­zu­ge­stal­ten, kann somit durchaus sinnvoll sein. Eine eigene Er­wei­te­rung ist außerdem auch eine her­vor­ra­gen­de Al­ter­na­ti­ve zu der gängigen +Funk­ti­ons­er­wei­te­rung der WordPress-In­stal­la­ti­on* mithilfe von Än­de­run­gen in der in­di­vi­du­el­len functions.php des ver­wen­de­ten Themes.

Vor­aus­set­zun­gen für die WordPress-Plugin-Pro­gram­mie­rung

Bevor Sie mit der Ent­wick­lung Ihres eigenen Plugins beginnen, sollten Sie si­cher­stel­len, dass Sie im Besitz der richtigen Werkzeuge und er­for­der­li­chen Grund­la­gen sind. Dazu benötigen Sie eine lokale Ent­wick­lungs­um­ge­bung mit einer WordPress-In­stal­la­ti­on. Eine einfache Mög­lich­keit hierfür bietet das kos­ten­lo­se Tool Local WP, mit dem Sie WordPress auf Ihrem eigenen Computer in­stal­lie­ren und testen können. Al­ter­na­tiv können Sie XAMPP oder MAMP verwenden, um eine lokale WordPress-Umgebung auf­zu­set­zen.

Neben einer funk­tio­nie­ren­den WordPress-In­stal­la­ti­on ist ein PHP-Editor oder eine PHP-IDE wie Visual Studio Code oder PhpStorm von Vorteil, wenn Sie Ihr eigenes WordPress-Plugin pro­gram­mie­ren. Ein grund­le­gen­des Ver­ständ­nis von PHP, HTML, CSS und Ja­va­Script ist ebenfalls hilfreich, um die Funk­ti­ons­wei­se von WordPress-Plugins besser zu verstehen.

WordPress-Plugin erstellen: Schritt für Schritt

Schritt 1: Plugin-Ver­zeich­nis und Haupt­da­tei anlegen

Jedes WordPress-Plugin wird in einem eigenen Ver­zeich­nis im wp-content/plugins/-Ordner der WordPress-In­stal­la­ti­on ge­spei­chert. Um Ihr eigenes Plugin zu erstellen, öffnen Sie diesen Ordner in Ihrem Datei-Explorer und legen dort einen neuen Ordner an. Diesem geben Sie einen aus­sa­ge­kräf­ti­gen Namen, zum Beispiel my-own-plugin.

Innerhalb dieses Ver­zeich­nis­ses erstellen Sie eine neue Datei mit dem Namen my-own-plugin.php. Diese Datei ist die Haupt­da­tei des Plugins und muss eine spezielle Kopfzeile enthalten, damit WordPress das Plugin erkennt. Öffnen Sie die Datei in Ihrem Code-Editor und fügen Sie folgenden Code ein:

<?php
/*
Plugin Name: My own plugin
Plugin URI: https://localhost/
Description: Demo plugin.
Version: 1.0
Author: IONOS
License: GPL2
*/

Diese Kom­men­tar­zei­len enthalten wichtige Me­ta­in­for­ma­tio­nen über das Plugin. Der Name des Plugins wird im WordPress-Ad­mi­nis­tra­ti­ons­be­reich angezeigt und die Be­schrei­bung kann dabei helfen, den Funk­ti­ons­um­fang oder An­wen­dungs­be­reich des Plugins zu verstehen. Da WordPress selbst der GNU General Public License (GPL) un­ter­liegt, sollten Sie eine Lizenz wählen, die sich mit dieser ver­ein­ba­ren lässt.

Nachdem Sie diese Datei ge­spei­chert haben, können Sie im WordPress-Backend den Menüpunkt „Plugins“ aufrufen. Dort sollte Ihr Plugin nun in der Liste er­schei­nen. Um es zu ak­ti­vie­ren, klicken Sie einfach auf „Ak­ti­vie­ren“. Da das Plugin bisher noch keine Funk­tio­na­li­tät enthält, hat diese Ak­ti­vie­rung noch keine sichtbare Aus­wir­kung, doch Sie haben damit bereits die Grundlage für Ihr eigenes Plugin ge­schaf­fen.

Close

Schritt 2: Erste Funk­tio­na­li­tät hin­zu­fü­gen

Um die Funk­ti­ons­wei­se unseres soeben er­stell­ten Plugins zu de­mons­trie­ren, fügen wir zunächst eine einfache Funktion hinzu, die einen spe­zi­el­len Text über einen WordPress-Shortcode ausgibt. Ein Shortcode ist eine kurze Zei­chen­fol­ge, die in WordPress-Beiträgen oder Seiten eingefügt wird und dort dy­na­mi­schen Inhalt ausgeben kann.

Ergänzen Sie in Ihrer Haupt­da­tei den folgenden Code:

function my_plugin_shortcode() {
return "<h2>Hello World!</h2>";
}
add_shortcode('my_shortcode', 'my_plugin_shortcode');

Diese Funktion erstellt einen neuen Shortcode mit dem Namen [my_shortcode]. Wenn dieser Shortcode nun in einen Beitrag oder eine Seite eingefügt wird, gibt WordPress au­to­ma­tisch den de­fi­nier­ten HTML-Code und somit ein „Hello World!“ aus.

Speichern Sie die Datei, gehen Sie in den WordPress-Editor und fügen Sie den Shortcode [my_shortcode] in eine neue Seite ein.

Close

Nach dem Speichern und Anzeigen der Seite sollte der de­fi­nier­te HTML-Text auf Ihrer Website sichtbar sein:

Close

Beachten Sie, dass der erstellte Shortcode in der Haupt­da­tei nur ex­em­pla­risch zeigen soll, wie ein eigenes WordPress-Plugin erstellt wird.

Schritt 3: Er­wei­ter­te Funk­tio­na­li­tät - Menü im WordPress-Ad­min­be­reich hin­zu­fü­gen

Ein eigenes Plugin kann auch ein eigenes Menü im WordPress-Ad­min­be­reich erhalten. Dies ist besonders dann nützlich, wenn Ihr Plugin eine eigene Be­nut­zer­ober­flä­che benötigt, bei­spiels­wei­se für Ein­stel­lun­gen oder Sta­tis­ti­ken.

Um ein Menü für das Plugin zu erstellen, fügen Sie den folgenden Code in Ihre Haupt­da­tei ein:

function my_plugin_menu() {
add_menu_page(
'Mein Plugin',	// Titel der Seite
'Mein Plugin', 	// Name im Menü
'manage_options',	// Benutzerrechte
'mein-plugin',	// Slug der Seite
'my_plugin_site',	// Funktion, die die Seite rendert
'dashicons-admin-generic',	// Symbol
20	// Position im Menü
);
}
add_action('admin_menu', 'my_plugin_menu');
function my_plugin_site() {
echo "<h1>Willkommen zu meinem Plugin</h1>";
echo "<p>Hier könnten Sie eigene Einstellungen hinzufügen.</p>";
}

Nach dem Speichern und Neuladen Ihres WordPress-Backends sollte in der linken Sei­ten­leis­te der neue Menüpunkt „Mein Plugin“ er­schei­nen. Wenn Sie dar­auf­kli­cken, öffnet sich eine einfache Seite mit einer Über­schrift und einem Platz­hal­ter­text.

Close

Schritt 4: Styles und Skripte einbinden

Nur selten kommt ein WordPress-Plugin ohne weitere Skripte aus. Gerade um­fang­rei­che­re Plugins erfordern häufig er­wei­ter­te Funk­tio­na­li­tä­ten, die mit Ja­va­Script ein­ge­bun­den werden, oder aber ein de­di­zier­tes CSS-Styling.

Eigene CSS- oder Ja­va­Script-Dateien können Sie über die wp_enqueue_scripts-Funktion einbinden. Legen Sie dazu innerhalb Ihres Plugin-Ver­zeich­nis­ses einen Ordner namens assets an und darin einen weiteren Ordner css. Erstellen Sie in diesem Ordner eine Datei namens style.css und fügen Sie bei­spiel­haft folgende CSS-Regel ein, die den Hin­ter­grund Ihrer WordPress-Page hellblau färbt:

body {
background-color: #87b9ff;
}
Mit diesem Code haben Sie ein eigenes, wenn auch sehr rudimentäres Stylesheet erstellt. Nun müssen Sie dieses in Ihr Plugin einbinden. Fügen Sie dazu diesen Code in Ihre `my-own-plugin.php`-Datei ein:
```php
function my_plugin_scripts() {
wp_enqueue_style('my-plugin-css', plugin_dir_url(__FILE__) . 'assets/css/style.css');
}
add_action('wp_enqueue_scripts', 'my_plugin_scripts');

Close

Schritt 5: Plugin-Ein­stel­lun­gen in der Datenbank speichern

In vielen Fällen und gerade bei kom­ple­xe­ren Plugins ist es notwendig, dass be­nut­zer­de­fi­nier­te Ein­stel­lun­gen ge­spei­chert werden. WordPress bietet hierfür die register_setting-Funktion. Mit dem folgenden Code können Sie eine einfache Ein­stel­lungs­sei­te für Ihr WordPress-Plugin pro­gram­mie­ren:

function my_plugin_settings() {
add_options_page(
'Mein Plugin Einstellungen',
'Mein Plugin',
'manage_options',
'mein-plugin-einstellungen',
my_plugin_settings_site
);
}
add_action('admin_menu', my_plugin_settings);
function my_plugin_settings_site() {
?>
<div class="wrap">
<h1>Mein Plugin Einstellungen</h1>
<form method="post" action="options.php">
<?php
settings_fields(my_plugin_options);
do_settings_sections(my-plugin-settings);
submit_button();
?>
</form>
</div>
<?php
}

Nach dem Speichern erscheint unter „Ein­stel­lun­gen“ im Admin-Bereich ein neuer Eintrag für Ihr Plugin.

Close

Fazit

Diese Anleitung hat die ele­men­ta­ren Schritte zur Ent­wick­lung eines eigenen WordPress-Plugins gezeigt. Mit diesen Grund­la­gen können Sie nun kom­ple­xe­re Funk­tio­nen in Ihr Plugin in­te­grie­ren, etwa API-Aufrufe, die mit externen Diensten kom­mu­ni­zie­ren, oder die Er­stel­lung von be­nut­zer­de­fi­nier­ten Post Types, um Inhalte spe­zi­fi­scher und flexibler zu verwalten.