Installer wp-cli sous Windows

WP-CLI est un outil en ligne de commande exclusivement utilisé pour WordPress afin de réaliser diverses tâches utiles sans passer par l’interface d’administration web. WP-CLI nécessite l’outil de commande « PHP-CLI » pour fonctionner. Ce mémo indique comment installer WP-CLI et simplifier son utilisation en ligne de commande.

Prérequis

Vérifiez que PHP est présent dans votre environnement Windows en inscrivant dans votre terminal la commande suivante :

php -v
  • Si vous obtenez la version de PHP, vous pouvez passer à l’étape suivante

Téléchargement

Téléchargez le fichier wp-cli.phar en cliquant sur ce lien : https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

Installation

Placez le fichier wp-cli.phar dans votre répertoire racine contenant votre site WordPress.

Tester avec la commande :

php wp-cli.phar --info

Si vous obtenez une erreur à la place des informations attendues, vérifiez si les outils PHP ou WP-CLI sont bien configurés est reconnus par votre terminal Windows (PATH) .

Optimisation (Optionnel)

Utiliser globalement dans Windows ( PATH )

Pour en savoir plus sur le fonctionnement global : Qu’est-ce que la variable PATH de Windows 10 et comment l’utiliser

Placer le fichier wp-cli.phar dans un dossier global en fonction de votre organisation.

Exemple :

C:\wp\wp-cli.phar

Entrez le raccourci [ Windows + i ] , puis, comme le montre l’illustration ci-dessous, commencez votre recherche par « variable » puis cliquez sur la proposition « Modifier les variables d’environnement système ».

Une fenêtre propriété système s’ouvre, cliquez le bouton en bas nommé : « Variables d’environnement »

Dans la fenêtre des variables d’environnement, recherchez dans la zone « variables système » une variable nommée Path, sélectionnez-la, puis cliquez sur « modifier ».

L’attribut alt de cette image est vide, son nom de fichier est variable-environnement-ajout.png.

Dans la fenêtre de modification de la variable d’environnement « Path », ajoutez une nouvelle ligne pour définir le chemin vers le dossier WP. ( dans l’exemple nous utilisons « C:\WP »).

Simplifier la commande

Pour transformer la commande par défaut :

php wp-cli.phar

en une commande plus simple :

wp

Pour cela, créez un nouveau fichier texte, puis modifiez-le à l’aide de l’éditeur de texte Windows.

inscrivez la ligne suivante dans le fichier :

@php "%~dp0wp-cli.phar" %*

Sauvegarder ce fichier sous le nom « wp.bat » en vous assurant que le type d’encodage UTF-8 soit bien sélectionné.

Vous pouvez supprimer le fichier de texte « nouveau fichier » devenu inutile.

Attention : Le fichier « wp.bat » doit être dans le même dossier que celui de « wp-cli.phar ». Ce dossier étant déclaré dans la variable « PATH » de Windows comme expliqué précédemment.

Tester la commande simplifiée

Lancer la ligne de commande suivante :

wp --info

Si vous obtenez les informations concernant « WP-CLI », vous avez réussi.

Erreurs possibles

Si vous obtenez un message d’erreur, veuillez vérifier les points suivants :

  • le dossier contenant « PHP » n’est pas déclarer ou mal configuré dans la variable « PATH » de Windows
  • le dossier contenant « wp-cli.phar » et « wp.bat » n’est pas déclarer ou mal configuré dans la variable « PATH » de Windows
  • la ligne inscrite dans wp.bat est mal configurée ou n’est pas enregistrée en « UTF-8 »