WP-CLIをWindows環境にインストールする方法

この記事ではWindows環境でのWP-CLIのインストール方法について解説します。インストールからパスの通し方について解説していますのでご覧ください。

注意点としてComposerやDocker経由でのインストール方法は解説していませんのでご理解ください。

動作環境

  • PHP 5.6 またはそれ以降のバージョン
  • 仮想環境はMAMP/XAMMP

PowerShellまたはテキストエディターなどのターミナルからphp -vと入力し実行結果があれば問題ありません。

PS C:\MAMP\htdocs\wp-cli-test> php -v
PHP 8.3.1 (cli) (built: Jan 16 2024 11:57:11) (ZTS Visual C++ 2019 x64)
Copyright (c) The PHP Group
Zend Engine v4.3.1, Copyright (c) Zend Technologies

WP-CLIのインストールについて

WP-CLIを使うにはPHPのインストールが必須です。なのでphp -vで返答があることを確認してください。

次にwp-cli.pharをダウンロードします。PowerShellからのダウンロードが手間な人は先ほどのリンクまたは、下記の公式ページからwp-cli.pharリンクをダウンロードしてください。

Installing

PowerShellからインストール

コマンドプロンプトまたはPowerShellを起動します。初期設定時だと下記のディレクトリの位置で起動されるかと思います。

PS C:\Users\USER_NAME>

WP-CLI関連のファイルをCドライブ直下に置きたいので下記のコマンドで移動します。

PS C:\Users\USER_NAME> cd /

次にwp-cliディレクトリを作成します。

PS C:\> mkdir wp-cli

wp-cliディレクトリに移動。

PS C:\> cd wp-cli

そしてwp-cli.pharをダウンロードします。問題なければ下記のような結果が表示されると思います。

PS C:\wp-cli> curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 6882k  100 6882k    0     0  6775k      0  0:00:01  0:00:01 --:--:-- 6787k
PS C:\wp-cli>

もしcurlコマンドでInvoke-WebRequestといったエラーが表示されたら下記のコマンドを入力してから上記のコマンドを実行してみてください。

PS C:\wp-cli> del alias:curl

wp-cliディレクトリに問題なくダウンロードできていればphp wp-cli.phar --infoと入力することでwp-cliが動作可能な状態になっているかと思います。

PS C:\wp-cli> php wp-cli.phar --info
OS:     Windows NT 10.0 build 26100 (Windows 11) AMD64
Shell:  C:\Windows\system32\cmd.exe
PHP binary:     C:\MAMP\bin\php\php8.3.1\php.exe
PHP version:    8.3.1
php.ini used:   C:\MAMP\bin\php\php8.3.1\php.ini
MySQL binary:
MySQL version:
SQL modes:
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:       C:\wp-cli
WP-CLI packages dir:
WP-CLI cache dir:       C:\Users\USER-NAME/.wp-cli/cache
WP-CLI global config:
WP-CLI project config:
WP-CLI version: 2.11.0

wp.batファイルの作成と環境変数の設定

続いて環境変数の設定のためwp.batというファイルをwp-cliディレクトリ内に作成します。下記のコマンドを実行するとエクスプローラーが起動します。

PS C:\wp-cli> ii .

右クリック【新規作成】>【テキストドキュメント】を選択し画像のようにファイルを作成して下さい。

wp.batファイルの中を下記のコードを埋め込み保存をしてください。

@ECHO OFF
php "c:/wp-cli/wp-cli.phar" %*

続いてPowerShellに戻り下記のコマンドを実行します。問題なければ保存されます。

PS C:\wp-cli> setx path "%path%;c:\wp-cli"

成功: 指定した値は保存されました。

この設定で問題なければ環境変数の登録が終わりWP-CLIコマンドが実行可能になっています。確認のため下記のコマンドを実行してみてください。

wp --info

Git Bashの場合のWP-CLIの設定

Git Bashで同様にwp –infoと入力すると下記のようなエラーが表示されるでしょう。

$ wp --info
bash: wp: command not found

Git Bashの場合Poweshellで設定した環境変数のパスは通らないので登録する必要があります。登録といってもaliasの登録を行います。上記で設定したc:/wp-cli/wp-cli.pharにインストールしたのであれば下記のコマンドを実行すればGit Bashでも結果が得られるかと思います。

$ php /c/wp-cli/wp-cli.phar --info

基本的にWP-CLIはPHPとwp-cli.pharが読み込めれば動作可能な状態なので上記のPATHを次のようにwpとして登録します。

alias wp='php /c/wp-cli/wp-cli.phar'

aliasの登録

Git Bashを開きユーザーディレクトリに移動します。通常起動すれば移動できているかと思います。移動出来たら.bashrcファイルを作成します。

$ touch .bashrc

次に.bashrcファイルを開きaliasの登録を行います。

$ vi .bashrc

開けたら下記のコードを入力。

alias wp='php /c/wp-cli/wp-cli.phar'

ESCを押し:wqと入力し保存します。

viが閉じられたら一度Git Bashを閉じ再度起動します。起動すると下記のようにエラーが表示されますが、自動的にユーザーディレクトリに.bash_profileファイルを作成してくれます。

WARNING: Found ~/.bashrc but no ~/.bash_profile, ~/.bash_login or ~/.profile.

This looks like an incorrect setup.
A ~/.bash_profile that loads ~/.bashrc will be created for you.

もう一度Git Bashを閉じ再起動すればwpコマンドが実行可能になります。

参考文献