WP-CLIの使い方: その壱 – インストールと簡単な使い方の例

ページ作成日: 2013-05-05 / ページ更新日: 2014-11-10 / 変更履歴

目次

  1. WP-CLIとは
  2. このページについて
  3. 注意事項
  4. 必要条件
  5. WP-CLIのインストール
  6. WP-CLIのアップデート
  7. 簡単な使い方の例
  8. ヘルプの参照
  9. このページの変更履歴

1. WP-CLIとは

WordPressを操作、管理するためのコマンドラインツールのセットです。コマンドラインでWordPressをインストールしたりプラグインをアップデートしたり投稿を作成したりなどなど、WordPressの管理画面でできることプラスアルファの操作が可能です。

で、コマンドラインでやって何がいいの？かというと、自動化できる！というのが一番のいいこと！です。

例えば、WordPressの最新日本語版をダウンロードして、データベース作成して、インストールして、プラグインをいくつか入れて有効化して、テーマも入れて、オプションをいくつか設定して、といういことが簡単なシェルスクリプトで実現できちゃいます。

2. このページについて

このページでは、

などを元にローカル環境での使い方を説明します。sshでログインできるサーバであれば、リモートでも（Unix/Linux系なら）同じように動くはずです。

3. 注意事項

  • このページは2014年2月12日現在の情報を元にしています。もしかしたらこのページの情報が古くなっているかもしれませんので、適宜WP-CLI ホームページを確認してください。
  • 前提としてMac上のローカルでHomebrewで構築したウェブ環境上にWordPressがすでに動いていることを想定しています。その環境が無い方はまずはMacのローカルでWordPressが動くようにしておいてください。MAMPで利用する場合は別に設定が必要みたいなので、とーるさんの「WP-CLIをMAMP環境で使う」を参考にしてください。
  • Unix/Linuxだったらパスが違うかもしれませんが、ほぼ同じ方法で動くはずです。
  • Windowsは、、、分かりません。。。

4. 必要条件

  • Unix系の環境(OS X, Linux, FreeBSD, Cygwin)
  • PHP 5.3.2以上
  • WordPress 3.5.2以上

5. WP-CLIのインストール

注意: 以前ここで紹介していたComposerを利用した方法は非推奨となりました。

OSXでHomebrewが入っている場合は、

[shell]
brew tap josegonzalez/homebrew-php
brew install wp-cli
[/shell]

以前のComposer版が入ってる場合はそちらが優先されるので削除してください。

Homebrewを入れてないOSXもしくは*nixでは、コマンドラインで以下を実行します。Windowsはその他のインストール方法(英語)を参照してください。

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

インストールされたことを確認するには、

[shell]
php wp-cli.phar –info
[/shell]
と入力して
[shell]
PHP binary: /usr/local/Cellar/php55/5.5.9/bin/php
PHP version: 5.5.9
php.ini used: /usr/local/etc/php/5.5/php.ini
WP-CLI root dir: phar://wp-cli.phar
WP-CLI global config:
WP-CLI project config:
WP-CLI version: 0.14.0
[/shell]
のように表示されればおっけです。

以前のようにwpでコマンドを利用するには、

[shell]
chmod +x wp-cli.phar
mv wp-cli.phar /usr/bin/wp
[/shell]

のようにします。

タブ補完

Homebrewの場合はそのままでbash補完が使えますが、wp-cli.pharを利用してbash補完させるには
wp-completion.bashをダウンロードして ~/.bash_profileから読み込みます:

[shell]
source /FULL/PATH/TO/wp-completion.bash
[/shell]

source ~/.bash_profile を実行すると bash に反映されます。

6. WP-CLIのアップデート

Homebrewの場合はHomebrewでアップデートできます。

[shell]
brew update
brew upgrade
[/shell]

wp-cli.pharの場合は上のインストールした時のコマンドを再度実行します。

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

7. 簡単な使い方の例

ほんでは、簡単な使い方の例として Contact Form 7 プラグインをインストールして有効化してみまひょー。

まずはWordPressがインストールされているディレクトリに移動します。
[shell]
$ cd /var/www/wordpress
[/shell]
次に wp plugin install プラグインスラッグ --activate を入力します。
--activate オプションを追加するとインストール後に有効化してくれます。
[shell]
$ wp plugin install contact-form-7 –activate
Installing Contact Form 7 (3.4)
http://downloads.wordpress.org/plugin/contact-form-7.3.4.zip からインストールパッケージをダウンロードしています…
パッケージを展開しています…
プラグインをインストールしています…
プラグインのインストールが完了しました。
Activating ‘contact-form-7’…
Success: Plugin ‘contact-form-7’ activated.
[/shell]
すでに最新版がインストール済みの場合は
[shell]
$ wp plugin install contact-form-7
Installing Contact Form 7 (3.4)
Error: Latest version already installed.
[/shell]
と表示されます。

次にプラグインの状態を見てみまひょー。
コマンドは wp plugin status です。
[shell]
$ wp plugin status
4 installed plugins:
I akismet
A contact-form-7
UI hello-dolly
I wp-multibyte-patch

Legend: I = Inactive, A = Active, U = Update Available
[/shell]
お、Hello Dolly プラグインのアップデートがあるようですので、wp plugin update hello-dolly と入力してアップデートします。
アップデートが複数以上利用可能ですべてをアップデートするには wp plugin update -all と入力します。
[shell]
$ wp plugin update hello-dolly
http://downloads.wordpress.org/plugin/hello-dolly.1.6.zip から更新をダウンロードしています…
更新を展開しています…
最新のバージョンをインストールしています…
プラグインの古いバージョンを削除しています…
プラグインの更新に成功しました。
[/shell]

8. ヘルプの参照

利用可能なコマンドとオプションは help コマンドで確認できます。
例えば wp help plugin と入力すると wp plugin で利用可能なサブコマンドやオプションを表示します。
[shell]
$ wp help plugin
usage: wp plugin activate [–network]
or: wp plugin deactivate [–network]
or: wp plugin delete
or: wp plugin install <plugin|zip> [–version=] [–activate]
or: wp plugin path [] [–dir]
or: wp plugin status []
or: wp plugin toggle [–network]
or: wp plugin uninstall [–no-delete]
or: wp plugin update [–version=]
or: wp plugin update-all [–dry-run]

See ‘wp help plugin ‘ for more information on a specific subcommand.
[/shell]
サブコマンドまで入れるとmanページが表示されます。
[shell]
$ wp help plugin install

OPTIONS
plugin:

A plugin slug or the path to a zip file.

–version=version:

If set, get that particular version from wordpress.org, instead
of the stable version.

–activate:

If set, the plugin will be activated immediately after install.

EXAMPLES
wp plugin install bbpress –version=2.1 –activate

wp plugin install bbpress –version=dev

wp plugin install ../my-plugin.zip

WP-CLI WP-PLUGIN-INSTALL(1)
[/shell]

このページの変更履歴

  1. 2013-05-20: インストール方法をcomposerを使ったものにアップデート
  2. 2013-05-20: アップデートの方法を追加
  3. 2013-06-03: <code></code>のスタイルを追加
  4. 2013-08-11: インストール方法を更新。MAMPでの使い方としてToruさんのページを紹介。Toruさん、ありがとうー！
  5. 2013-09-29: インストールされる場所が~/.composerから~/.wp-cliに変わったので修正
  6. 2013-10-13: WP-CLIのアップデート方法を修正
  7. 2014-02-12: インストール方法を修正。アップデート方法を修正
  8. 2014-11-10: ダウンロードのURLが変更されてたので修正
  9. 2014-12-13: 軽微な文章の修正

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です