© McCarony/Shutterstock.com
Entwickler Magazin
WP-CLI: das Kommandozeilenwerkzeug für WordPress

Das Schweizer Messer für Entwickler

Wer WP-CLI noch nicht benutzt, verpasst etwas. Damit zu arbeiten, ist ein wahrer Geschwindigkeitsrausch für Plug-in-, Theme- und WordPress-Macher. Es handelt sich um ein Werkzeug, das die träge Verwaltung per Browser durch schnelle Befehle auf der Konsole ersetzt. Auch Tests und kollaboratives Arbeiten werden dadurch leichter.

Mike Pretzlaw


Es ist allgemein bekannt, dass zu jedem guten System auch ein Werkzeug auf Kommandozeilenebene gehört, die auch Konsole, Terminal oder CLI genannt wird. Magento hat Magerun, mit dem sich Produkte, Warenkörbe und Co. verwalten lassen. Symfony bringt bin/console mit, das tiefe Einblicke in Routing, Datenbank, Caching und mehr ermöglicht. In WordPress gibt es das WP-CLI, womit sich Beiträge, Seiten, Optionen, Benutzer, Plug-ins (Abb. 1) und sehr viel mehr verwalten lassen – alles ohne den Browser, komplett über das CLI.

Abb. 1: Beispiel: Alle Plug-ins einer Webseite auflisten

WP-CLI ist für jeden WordPress-Kenner so intuitiv zu bedienen, dass bereits zwei bis drei Beispiele ausreichen, um ein Gefühl für die Struktur der Befehle zu bekommen. Der Befehl wp startet WP-CLI. Darauf folgt ein bestimmter Bereich in WordPress, z. B. ein Plug-in (Abb. 2) oder eine Option (Abb. 3). Danach kommt eine Aktion, die dort ausgeführt werden soll. Im Allgemeinen gilt also:

wp [Optionen]

Zum Beispiel:

wp plugin list

wp plugin update hello-dolly

wp plugin update --all

Abb. 2: Plug-ins mit WP-CLI updaten

Abb. 3: „wp option get home“

Eine vollständige Liste aller Befehle und deren Aufbau kann über den Befehl wp help ausgeben werden. Per wp help [Befehl] wird eine detaillierte Dokumentation zu einzelnen Befehlen aufgerufen.

Eigene Befehle für Plug-ins und Themes definieren

Wer ein Plug-in oder Theme entwickelt, möchte dessen Strukturen, Entitäten und Optionen wahrscheinlich auch über WP-CLI kontrollieren. WooCommerce ist ein bekanntes Beispiel für ein Plug-in, das Befehle wie wp woo product create oder woo order delete mitbringt. Damit ist der Shop über das Terminal anstelle des Browsers steuerbar, was DevOps/SysOps die Arbeit erleichtert. Das wollen wir für unsere eigenen Plug-ins auch.

Zur Demonstration der Möglichkeiten von WP-CLI wollen wir ein Plug-in entwickeln, das sich um die Verwaltung von Tieren in einem Tierheim kümmert. Was bequem per Backend funktioniert, soll auch über das Terminal möglich sein. Über den Befehl wp animal add [Name] lässt sich ein Tier hinzufügen. Ein adoptiertes Tier wird per wp animal adopt [Name] wieder entfernt.

Es gibt verschiedene Varianten, um Befehle in WP-CLI zu registrieren: per Funktion, pro Klassenmethode ein Befehl oder sogar pro Befehl eine komplett eigene Klasse. Zusammen mit der Magie der Doc Comments ist das ein riesiges Thema für sich und k...

Entwickler Magazin
WP-CLI: das Kommandozeilenwerkzeug für WordPress

Das Schweizer Messer für Entwickler

Wer WP-CLI noch nicht benutzt, verpasst etwas. Damit zu arbeiten, ist ein wahrer Geschwindigkeitsrausch für Plug-in-, Theme- und WordPress-Macher. Es handelt sich um ein Werkzeug, das die träge Verwaltung per Browser durch schnelle Befehle auf der Konsole ersetzt. Auch Tests und kollaboratives Arbeiten werden dadurch leichter.

Mike Pretzlaw


Es ist allgemein bekannt, dass zu jedem guten System auch ein Werkzeug auf Kommandozeilenebene gehört, die auch Konsole, Terminal oder CLI genannt wird. Magento hat Magerun, mit dem sich Produkte, Warenkörbe und Co. verwalten lassen. Symfony bringt bin/console mit, das tiefe Einblicke in Routing, Datenbank, Caching und mehr ermöglicht. In WordPress gibt es das WP-CLI, womit sich Beiträge, Seiten, Optionen, Benutzer, Plug-ins (Abb. 1) und sehr viel mehr verwalten lassen – alles ohne den Browser, komplett über das CLI.

Abb. 1: Beispiel: Alle Plug-ins einer Webseite auflisten

WP-CLI ist für jeden WordPress-Kenner so intuitiv zu bedienen, dass bereits zwei bis drei Beispiele ausreichen, um ein Gefühl für die Struktur der Befehle zu bekommen. Der Befehl wp startet WP-CLI. Darauf folgt ein bestimmter Bereich in WordPress, z. B. ein Plug-in (Abb. 2) oder eine Option (Abb. 3). Danach kommt eine Aktion, die dort ausgeführt werden soll. Im Allgemeinen gilt also:

wp [Optionen]

Zum Beispiel:

wp plugin list

wp plugin update hello-dolly

wp plugin update --all

Abb. 2: Plug-ins mit WP-CLI updaten

Abb. 3: „wp option get home“

Eine vollständige Liste aller Befehle und deren Aufbau kann über den Befehl wp help ausgeben werden. Per wp help [Befehl] wird eine detaillierte Dokumentation zu einzelnen Befehlen aufgerufen.

Eigene Befehle für Plug-ins und Themes definieren

Wer ein Plug-in oder Theme entwickelt, möchte dessen Strukturen, Entitäten und Optionen wahrscheinlich auch über WP-CLI kontrollieren. WooCommerce ist ein bekanntes Beispiel für ein Plug-in, das Befehle wie wp woo product create oder woo order delete mitbringt. Damit ist der Shop über das Terminal anstelle des Browsers steuerbar, was DevOps/SysOps die Arbeit erleichtert. Das wollen wir für unsere eigenen Plug-ins auch.

Zur Demonstration der Möglichkeiten von WP-CLI wollen wir ein Plug-in entwickeln, das sich um die Verwaltung von Tieren in einem Tierheim kümmert. Was bequem per Backend funktioniert, soll auch über das Terminal möglich sein. Über den Befehl wp animal add [Name] lässt sich ein Tier hinzufügen. Ein adoptiertes Tier wird per wp animal adopt [Name] wieder entfernt.

Es gibt verschiedene Varianten, um Befehle in WP-CLI zu registrieren: per Funktion, pro Klassenmethode ein Befehl oder sogar pro Befehl eine komplett eigene Klasse. Zusammen mit der Magie der Doc Comments ist das ein riesiges Thema für sich und k...

Neugierig geworden?


   
Loading...

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang