Exit-Codes

WP-CLIWP-CLI WP-CLI ist die Befehlszeilenschnittstelle für WordPress, die verwendet wird, um administrative Aufgaben und Entwicklungsaufgaben programmatisch auszuführen. Die Projektseite ist http://wp-cli.org/ https://make.wordpress.org/cli/ folgt weit verbreiteten Unix-Konventionen für Exit-Codes: 0 signalisiert Erfolg (die primäre Bedingung des Befehls wurde erfüllt), während Werte ungleich null signalisieren, dass die primäre Bedingung nicht erfüllt wurde. Dies kann entweder einen Betriebsfehler darstellen (der Befehl konnte den angeforderten Vorgang nicht ausführen) oder ein erwartetes negatives Ergebnis, das aufrufende Skripte prüfen sollen (zum Beispiel „nicht installiert“). Skripte, die WP-CLI-Befehle aufrufen, können den Exit-Code prüfen, um zu bestimmen, ob sie fortfahren, es erneut versuchen oder abbrechen sollen.

Standard-Exit-Codes

WP_CLI::error() (Dokumentation) ist die übliche Methode, um einen Fehler zu melden und mit dem Code 1 zu beenden.

WP_CLI::halt() (Dokumentation) kann verwendet werden, um mit einem bestimmten Wert ungleich null zu beenden, wenn der Befehl dem aufrufenden Skript ein bestimmtes Ergebnis mitteilen muss.

Exit-Codes für Befehle mit booleschem Ergebnis

Einige Befehle sind darauf ausgelegt, ein binäres Ergebnis direkt über den Exit-Code und nicht über die Ausgabe zu übermitteln. Diese Befehle verwenden weiterhin die Standardcodes 0/1, aber 1 bedeutet „Bedingung nicht erfüllt“ und nicht „Betriebsfehler“. Zum Beispiel:

• wp plugin is-installed <plugin> wird mit 0 beendet, wenn das PluginPlugin Ein Plugin ist eine Software, die eine Gruppe von Funktionen enthält, die einer WordPress-Website hinzugefügt werden können. Plugins können die Funktionalität erweitern oder neue Funktionen zu Ihren WordPress-Websites hinzufügen. WordPress-Plugins werden in der Programmiersprache PHP geschrieben und lassen sich nahtlos in WordPress integrieren. Sie können kostenlos im WordPress.org-Plugin-Verzeichnis https://wordpress.org/plugins/ erhältlich sein oder von Drittanbietern kostenpflichtig angeboten werden. installiert ist, und mit 1, wenn es nicht installiert ist.
• wp theme is-installed <theme> folgt demselben Muster.
• wp core is-installed wird mit 0 beendet, wenn WordPress installiert ist, und mit 1, wenn dies nicht der Fall ist.

Verwenden Sie den Exit-Code 1, um „Bedingung nicht erfüllt“ (und nicht einen Fehler) zu signalisieren, wenn:

1. Das Befehlsergebnis binär ist (bestanden/fehlgeschlagen, gefunden/nicht gefunden) und direkt in einer Shell-Bedingung geprüft werden soll.
2. Die Absicht ausdrücklich dokumentiert ist, damit Skriptautoren wissen, dass der Exit-Code eine Ergebnisbedeutung und keine Fehlerbedeutung hat.

Geben Sie für Bedingungen, die lediglich informativ und kein eindeutiges Ergebnis sind, **keinen** Exit-Code ungleich null zurück (z. B. ist ein Listenbefehl, der keine Elemente findet, dennoch ein erfolgreicher Vorgang – er hat eine leere Liste zurückgegeben).

Verwendung von Exit-Codes in Skripten

Da WP-CLI standardmäßige Exit-Codes verwendet, können Sie WP-CLI-Befehle direkt in Shell-Bedingungen verwenden:

# Prüfen, ob ein Plugin installiert ist, bevor versucht wird, es zu aktivieren
if wp plugin is-installed my-plugin; then
    wp plugin activate my-plugin
else
    echo "Plugin nicht installiert"
    exit 1
fi

Sie können auch nach jedem WP-CLI-Befehl $? prüfen, um festzustellen, ob er erfolgreich war:

wp core update
if [ "$?" -ne 0 ]; then
    echo "Aktualisierung fehlgeschlagen"
fi