WordPress CLI installieren und Scaffolding erklärt #4
author Colin Atkins, 05.08.2019

Bei einem kürzlichen Projekt sind wir auf die WordPress CLI gestoßen.

Ein CLI steht für Command Line Interface. Mittels der CLI können Entwickler schnell Befehle über eine Textkonsole eingeben. Inbesondere mit dem Scaffolding können neue Blöcke oder Plugins generiert werden.

Im Fall der WordPress CLI kann man manche Befehle ausschliesslich nur über diese starten und nicht im Backendbereich.

Folgende Befehle umfasst die Scaffold CLI, alle Befehle der CLI findet ihr hier:

wp scaffold block

Generates PHP, JS and CSS code for registering a Gutenberg block for a plugin or theme.

wp scaffold child-theme

Generates child theme based on an existing theme.

wp scaffold plugin

Generates starter code for a plugin.

wp scaffold plugin-tests

Generates files needed for running PHPUnit tests in a plugin.

wp scaffold post-type

Generates PHP code for registering a custom post type.

wp scaffold taxonomy

Generates PHP code for registering a custom taxonomy.

wp scaffold theme-tests

Generates files needed for running PHPUnit tests in a theme.

wp scaffold underscores

Generates starter code for a theme based on _s.

wp scaffold _s

Generates starter code for a theme based on _s.

Die Konsolen Befehle lassen sich dann im Hauptverzeichnis einer installierten WordPress-Installation starten.

Und so installiert Ihr die CLI auf einem eurer Webserver

Voraussetzungen

  1. SSH-Zugriff auf euren Webserver (Bash)
  2. CURL
  3. Vorhandene WordPress Installation
  4. mind. PHP5.6

1. WP-CLI herunterladen

Wechselt in das Root-Verzeichnis (oder einem aus dem Internet nicht erreichbaren Verzeichnes) eures SSH-Users. Gebt dazu nach dem Login folgenden Befehl ein:

cd

Lädt nun die PHAR-Datei herunter:

curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

Startet einmal einen Testlauf:

php wp-cli.phar --info

Es sollte ein vergleichbarer Auswurf erscheinen:

OS:    Linux
Shell:    /bin/bash
PHP binary:    /usr/bin/php5
PHP version:    5.5.9-1ubuntu4.27
php.ini used:    /etc/php5/cli/php.ini
WP-CLI root dir:    phar://wp-cli.phar/vendor/wp-cli/wp-cli
WP-CLI vendor dir:    phar://wp-cli.phar/vendor
WP_CLI phar path:    /var/www/vhosts/dir
WP-CLI packages dir:   
WP-CLI global config:   
WP-CLI project config:   
WP-CLI version:    2.2.0

Nun noch die Ausführrechte festlegen:

chmod +x wp-cli.phar

2. WP-CLI Alias festlegen

Findet erstmal den absoluten Pfad zu der wp-cli.phar Datei heraus. Während Ihr im gleichen Verzeichnis seit gibt folgenden Befehl ein:

pwd

Anschliessend den Pfad notieren/kopieren. Bei mir: /var/www/vhosts/dir

Damit wir nicht jedes mal den Pfad zur PHAR-Datei angeben müssen legen wir einen Alias fest. Gebt dabei den absoluten Pfad zu euer PHAR Datei im folgenden Befehl an, ersetzt dabei den fettgedruckten Pfad durch den vorherigen:

touch ~/.bash_profile && echo "alias wp='/var/www/vhosts/dir/wp-cli.phar'" >> ~/.bash_profile

Damit der Alias funktioniert müsst Ihr einmal die .bash_profile Datei "sourcen":

source ~/.bash_profile

3. WP-CLI ausprobieren

Wir probieren nun mal den Cache zu löschen mit folgenden Befehl. Wechselt dazu in den Ordner wo euer WordPress liegt und führt folgenden Befehl aus:

wp cache flush

Anschliessend erstellen wir für den Gutenberg Editor einen neuen Block (die genauen Befehle findet ihr unter den obigen Links):

wp scaffold block header-carousel --title="Header Carousel" --theme=bulmapress-master

 

Zusammenfassung

In diesem kleinem Tutorial habt Ihr erfahren wie man mittels SSH auf einem Webserver die WordPress CLI installiert. Die Links zur offiziellen Doku erläutern euch welche Befehle ihr mit welchen Kommandos nutzen könnt. Das CLI vereinfacht das anlegen von neuen Blöcken für den Gutenberg Editor.

 

 

Tags

wordpress cli install