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が入っている場合は、

<br />
brew tap josegonzalez/homebrew-php<br />
brew install wp-cli<br />

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

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

<br />
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar<br />

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

<br />
php wp-cli.phar --info<br />

と入力して
<br />
PHP binary: /usr/local/Cellar/php55/5.5.9/bin/php<br />
PHP version: 5.5.9<br />
php.ini used: /usr/local/etc/php/5.5/php.ini<br />
WP-CLI root dir: phar://wp-cli.phar<br />
WP-CLI global config:<br />
WP-CLI project config:<br />
WP-CLI version: 0.14.0<br />

のように表示されればおっけです。

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

<br />
chmod +x wp-cli.phar<br />
mv wp-cli.phar /usr/bin/wp<br />

のようにします。

タブ補完

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

<br />
source /FULL/PATH/TO/wp-completion.bash<br />

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

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

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

<br />
brew update<br />
brew upgrade<br />

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

<br />
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar<br />

7. 簡単な使い方の例

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

まずはWordPressがインストールされているディレクトリに移動します。

<br />
$ cd /var/www/wordpress<br />

次に wp plugin install プラグインスラッグ --activate を入力します。
--activate オプションを追加するとインストール後に有効化してくれます。
<br />
$ wp plugin install contact-form-7 --activate<br />
Installing Contact Form 7 (3.4)<br />
http://downloads.wordpress.org/plugin/contact-form-7.3.4.zip からインストールパッケージをダウンロードしています…<br />
パッケージを展開しています…<br />
プラグインをインストールしています…<br />
プラグインのインストールが完了しました。<br />
Activating 'contact-form-7'...<br />
Success: Plugin 'contact-form-7' activated.<br />

すでに最新版がインストール済みの場合は
<br />
$ wp plugin install contact-form-7<br />
Installing Contact Form 7 (3.4)<br />
Error: Latest version already installed.<br />

と表示されます。

次にプラグインの状態を見てみまひょー。
コマンドは wp plugin status です。

<br />
$ wp plugin status<br />
4 installed plugins:<br />
I akismet<br />
A contact-form-7<br />
UI hello-dolly<br />
I wp-multibyte-patch</p>
<p>Legend: I = Inactive, A = Active, U = Update Available<br />

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

8. ヘルプの参照

利用可能なコマンドとオプションは help コマンドで確認できます。
例えば wp help plugin と入力すると wp plugin で利用可能なサブコマンドやオプションを表示します。

<br />
$ wp help plugin<br />
usage: wp plugin activate [--network]<br />
or: wp plugin deactivate [--network]<br />
or: wp plugin delete<br />
or: wp plugin install &lt;plugin|zip&gt; [--version=] [--activate]<br />
or: wp plugin path [] [--dir]<br />
or: wp plugin status []<br />
or: wp plugin toggle [--network]<br />
or: wp plugin uninstall [--no-delete]<br />
or: wp plugin update [--version=]<br />
or: wp plugin update-all [--dry-run]</p>
<p>See 'wp help plugin ' for more information on a specific subcommand.<br />

サブコマンドまで入れるとmanページが表示されます。
<br />
$ wp help plugin install</p>
<p>OPTIONS<br />
plugin:</p>
<p>A plugin slug or the path to a zip file.</p>
<p>--version=version:</p>
<p>If set, get that particular version from wordpress.org, instead<br />
of the stable version.</p>
<p>--activate:</p>
<p>If set, the plugin will be activated immediately after install.</p>
<p>EXAMPLES<br />
wp plugin install bbpress --version=2.1 --activate</p>
<p>wp plugin install bbpress --version=dev</p>
<p>wp plugin install ../my-plugin.zip</p>
<p>WP-CLI WP-PLUGIN-INSTALL(1)<br />

このページの変更履歴

  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: 軽微な文章の修正

「WP-CLIの使い方: その壱 – インストールと簡単な使い方の例」への3件のフィードバック

コメントを残す