WP CLI in VS Code für Local Projekte

Einleitung

Da Local die Projekte in Containern ausführt, ist es nicht so easy, die im Container installierte WP-CLI direkt in VS Code auszuführen. Mit diesem Trick nutzt du stattdessen deine lokale Version.

Installiere Local und die WP CLI

Local ermöglicht es dir lokal mehrere voneinander getrennte WordPress Instanzen zu nutzen. Falls du es noch nicht nutzt, teste es unbedingt mal aus, es ist unfassbar einfach und zuverlässig.

Neben Local musst du für dieses Tutorial die WP CLI auf deinem System installiert haben.

Öffne dein Projekt in VS Code

Wenn du nun den Terminal öffnest und einen Befehl der WP CLI, wie z.B. wp user list eingibst, bekommst du einen Fehler: Error establishing a database connection.

Das liegt daran, dass die wp-config.php für den DB_HOST localhost definiert, was in dem Container, in dem die WordPress Instanz ausgeführt wird, auch Sinn macht. Wir wollen nun aber von außerhalb des Containers die Instanz per WP CLI steuern.

DB_HOST zeitweise überschreiben

Erstelle jetzt zwei neue Dateien und füge sie in den Root deines Projektes ein.

Die YAML Config Datei wp-cli.local.yml wird von der WP CLI automatisch beim Ausführen geladen. Dort legen wir fest, dass eine bestimmte PHP Datei mitgeladen werden soll.

path: .
require:
  - wp-cli.local.phpCode-Sprache: YAML (yaml)

Die Dateiwp-cli.local.php (du kannst sie auch anders nennen) wird jetzt jedes Mal geladen, wenn wir die WP CLI nutzen. In dieser überschreiben wir für die Nutzung der WP CLI den Datenbankpfad.

<?php
define(
	'DB_HOST',
	'localhost:/Users/BENUTZERORDNER/Library/Application Support/Local/run/IDSpexWqI/mysql/mysqld.sock'
);


// Only display fatal run-time errors.
// See http://php.net/manual/en/errorfunc.constants.php.
error_reporting( E_ERROR );

// Disable WordPress debug mode.
// See https://codex.wordpress.org/WP_DEBUG.
define( 'WP_DEBUG', false );Code-Sprache: PHP (php)

Den richtigen Datenbankpfad erfährst du in den Einstellungen zur Datenbank in Local.

Nutze die WP CLI in VS Code

Fertig. Wenn du nun den Befehl vom Anfang im Terminal von VS Code ausführst, solltest du die richtige Liste an Nutzern erhalten.

Ich konfiguriere mir jedes Projekt gleich beim Aufsetzen auf diese Weise.