WP-CLI The command line interface for WordPress

WP-CLI は WordPress を管理するためのコマンドラインインターフェースです。 プラグインのアップデートやマルチサイトのセットアップなどの多くのことをブラウザ無しで行うことができます。

現在のメンテナンスは、以下の企業のサポートにより支えられています。

現在の最新バージョンは 2.4.0 です。 最新情報を得たい人は、@wpcli on Twitter をフォローするか、メーリングリストにサインアップしてください。ロードマップで、今後のリリースの予定を知ることができます。

Build Status Average time to resolve an issue Percentage of issues still open

Quick links: 使い方 | インストール方法 | サポート | 拡張 | 貢献 | クレジット

使い方

WP-CLI は、みなさんが WordPress の管理画面でやりたいと思っていることに対するコマンドラインインターフェースを提供しています。 たとえば、wp plugin install --activate (ドキュメント) は、プラグインをインストールし有効化します。

$ wp plugin install user-switching --activate
Installing User Switching (1.0.9)
Downloading install package from https://downloads.wordpress.org/plugin/user-switching.1.0.9.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating 'user-switching'...
Plugin 'user-switching' activated.
Success: Installed 1 of 1 plugins.

さらに WP-CLI は、WordPress の管理画面ではできない多くのことが可能です。たとえば、wp transient delete --all (ドキュメント) は、Transient に保存されているすべてのデータを削除することを可能にしています。

$ wp transient delete --all
Success: 34 transients deleted from the database.

WP-CLI の使い方に関するさらに詳しい情報は、クイックスタートガイドを読んでください。または、shell friends で便利なコマンドラインユーティリティについて学ぶことができます。

もし、すでに基本的なことを理解しているなら、コマンドリストにジャンプして、テーマやプラグインの管理、データのインポートやエクスポート、データベースの操作などについての詳細をみてください。

インストール方法

Phar ファイルをダウンロードする方法が、私たちが推奨するインストール方法です。必要なら上級者向けインストール方法(英語)を見てください。

WP-CLI をインストールする前に、動作環境を確認してください。

動作条件を再度確認してから、wgetまたはcurlを使用して wp-cli.phar をダウンロードしてください。

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

次に、Phar ファイルが動作していることを確認してください。

$ php wp-cli.phar --info

WP-CLI コマンドをwpで実行するには、それに実行権限があることと環境変数PATHに登録されていることが必要です。

$ chmod +x wp-cli.phar
$ sudo mv wp-cli.phar /usr/local/bin/wp

もし、WP-CLI のインストールが成功していれば、wp --infoを実行したら以下のように出力されるはずです。

$ wp --info
OS:	Darwin 16.7.0 Darwin Kernel Version 16.7.0: Thu Jan 11 22:59:40 PST 2018; root:xnu-3789.73.8~1/RELEASE_X86_64 x86_64
Shell:	/bin/zsh
PHP binary:    /usr/local/bin/php
PHP version:    7.0.22
php.ini used:   /etc/local/etc/php/7.0/php.ini
WP-CLI root dir:        /home/wp-cli/.wp-cli/vendor/wp-cli/wp-cli
WP-CLI vendor dir:	    /home/wp-cli/.wp-cli/vendor
WP-CLI packages dir:    /home/wp-cli/.wp-cli/packages/
WP-CLI global config:   /home/wp-cli/.wp-cli/config.yml
WP-CLI project config:
WP-CLI version: 2.4.0

アップデート

WP-CLI をアップデートするには、wp cli update (ドキュメント) を実行するか、上述のインストール方法を再度行う必要があります。

WP-CLI のオーナーが root もしくは他のシステム管理者になっている場合は、sudo wp cli update と実行する必要があります。

もっととんがった生き方をしたい？ wp cli update --nightly を実行すれば、最新の開発者向けバージョンの WP-CLI を使用することができます。開発者向けバージョンは、あなたの開発環境で使用するのに十分な信頼性があり、つねに最新の機能を使用することができます。

タブ補完

WP-CLI には、Bash 及び ZSH 用のタブ補完用のスクリプトがあります。 wp-completion.bash をダウンロードして、~/.bash_profile から読み込んでください。

source /FULL/PATH/TO/wp-completion.bash

source ~/.bash_profile を実行するのを忘れないでください。

ZSH の場合は、bashcompinit を読み込ませたあとに wp-completion.bash を読み込ませる必要があるかもしれません。.zshrc へ次のコードを追加してください。

autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash

サポート

WP-CLI のメンテナーとその貢献者たちが一般的な質問に答えられる時間は限られています。最新版 のみが公式にサポートされるバージョンです。

もしサポートを探しているなら、まず初めに以下のリソースの中から答えを探してください。

もし、上のいずれかの方法で回答を見つけられなかった場合は:

GitHub Issues は、既存のコマンドの改良やバグを追跡するために使用されており、一般的なサポートのためには使用されていません。バグレポートを投稿する際には、ベストプラクティスを確認して、あなたが抱える問題が適時確実に伝わるように心がけてください。

Twitterでサポート用の質問をたずねるのはおやめください。Twitterは、文字数が140文字以下であり会話を行うのが難しい、過去の会話から他の人の同じ質問を検索することが難しい、等の理由によりサポートを行う場としてふさわしくありません。

自由は無料とは違います。オープンソースはあなたに自由に使ったり編集したりする権利を保証しますが、他の誰かの時間を浪費することを保証しているわけではありません。敬意をもって、過度な期待をしないように心がけてください。

拡張

それぞれの コマンド は、WP-CLI の関数の一つとして定義されています。wp plugin install (ドキュメント) はそのうちのひとつであり、wp plugin activate (ドキュメント) は別のもうひとつです。

WP-CLI では、様々な実行可能なクラス、関数、クロージャをコマンドとして実行することが可能です。コマンドとして実行されるために必要な情報は、PHPdoc によって記述します。 WP_CLI::add_command() (ドキュメント) は、内部コマンド及びサードパーティコマンドの登録に使用されています。

/**
 * Delete an option from the database.
 *
 * Returns an error if the option didn't exist.
 *
 * ## OPTIONS
 *
 * <key>
 * : Key for the option.
 *
 * ## EXAMPLES
 *
 *     $ wp option delete my_option
 *     Success: Deleted 'my_option' option.
 */
$delete_option_cmd = function( $args ) {
	list( $key ) = $args;

	if ( ! delete_option( $key ) ) {
		WP_CLI::error( "Could not delete '$key' option. Does it exist?" );
	} else {
		WP_CLI::success( "Deleted '$key' option." );
	}
};
WP_CLI::add_command( 'option delete', $delete_option_cmd );

WP-CLI は、多くのコマンドにより構成されており、カスタムコマンドを作ることは意外と簡単です。commands cookbookを読んでください。

貢献

ようこそ、そしてありがとう！

私たちは、みなさんが率先して貢献してくれることに感謝しています。あなたやあなたのまわりのコミュニティによって、WP-CLIはすばらしいプロジェクトになります。

貢献は単にコードだけではありません。 私たちは、チュートリアルを書く、地元のミートアップでデモを行う、ユーザーの質問への回答、ドキュメントの改訂など、あなたの日々の活動に応じた貢献をお願いしています。

プロジェクトに参加するには、ハンドブックの貢献者向けガイドラインをよく読んでください。ここに書かれていることに従うことで、本プロジェクトの他の貢献者たちとのコミュニケーションを円滑にすることができます。彼らは、世界をまたがってあなたと一緒に働くことに、最大限の敬意を払う努力をします。

プロジェクトリーダー

WP-CLI にはプロジェクトメンテナーがいます: schlessera です。

能力があり、プロジェクトを発展させるために、時間をかけて投資していることを示してくれたコントリビューターへ、コミット権限を与えることがあります。

プロジェクトの運営に関する詳細については、ハンドブック内のガバナンス を読んで下さい。

クレジット

composer.json に記載されているライブラリに依存しており、以下のプロジェクトからコードやアイディアを得ています。