WP-CLI は WordPress のコマンドライン インターフェイスです。 Web ブラウザを使用せずに、プラグインの更新、マルチサイト インストールの構成などを行うことができます。
継続的なメンテナンスは以下によって可能になります。
現在の安定版リリースはバージョン 2.11.0 です。お知らせについては、Twitter で @wpcli をフォローするか、電子メールで最新情報を受信してください。今後のリリースで予定されている内容の概要については、ロードマップを確認してください。
クイックリンク: | の使用インストール |サポート |拡張中 |貢献する |クレジット
WP-CLI は、WordPress 管理者で実行する可能性のある多くのアクションのためのコマンドライン インターフェイスを提供します。たとえば、 wp plugin install --activate
(doc) を使用すると、WordPress プラグインをインストールしてアクティブ化できます。
$ wp plugin install user-switching --activate
Installing User Switching (1.0.9)
Downloading installation 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
(doc) を使用すると、1 つまたはすべてのトランジェントを削除できます。
$ wp transient delete --all
Success: 34 transients deleted from the database.
WP-CLI の使用方法について詳しくは、クイック スタート ガイドをお読みください。または、シェル友達と交流して、便利なコマンド ライン ユーティリティについて学びましょう。
基本的な操作はすでに慣れていますか?コマンドの完全なリストに移動すると、テーマとプラグインの管理、データのインポートとエクスポート、データベースの検索と置換操作の実行などに関する詳細情報が表示されます。
Phar ファイルのダウンロードは、ほとんどのユーザーに推奨されるインストール方法です。必要に応じて、別のインストール方法 (Composer、Homebrew、Docker) に関するドキュメントも参照してください。
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
と入力して WP-CLI を使用するには、ファイルを実行可能にして PATH 内のどこかに移動します。例えば:
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp
WP-CLI が正常にインストールされている場合は、 wp --info
実行すると次のような内容が表示されるはずです。
$ wp --info
OS: Linux 5.10.60.1-microsoft-standard-WSL2 # 1 SMP Wed Aug 25 23:20:18 UTC 2021 x86_64
Shell: /usr/bin/zsh
PHP binary: /usr/bin/php8.1
PHP version: 8.1.0
php.ini used: /etc/php/8.1/cli/php.ini
MySQL binary: /usr/bin/mysql
MySQL version: mysql Ver 8.0.27-0ubuntu0.20.04.1 for Linux on x86_64 (( Ubuntu ))
SQL modes:
WP-CLI root dir: /home/wp-cli/
WP-CLI vendor dir: /home/wp-cli/vendor
WP_CLI phar path:
WP-CLI packages dir: /home/wp-cli/.wp-cli/packages/
WP-CLI global config:
WP-CLI project config: /home/wp-cli/wp-cli.yml
WP-CLI version: 2.11.0
WP-CLI は、 wp cli update
(doc) を使用するか、インストール手順を繰り返すことによって更新できます。
WP-CLI が root または別のシステム ユーザーによって所有されている場合は、 sudo wp cli update
実行する必要があります。
限界のある人生を送りたいですか? wp cli update --nightly
を実行して、WP-CLI の最新の nightly ビルドを使用します。夜間ビルドは開発環境で使用するのに十分安定しており、常に最新かつ最高の WP-CLI 機能が含まれています。
WP-CLI には、Bash および ZSH 用のタブ補完スクリプトも付属しています。 wp-completion.bash をダウンロードし、 ~/.bash_profile
からソースするだけです。
source /FULL/PATH/TO/wp-completion.bash
その後、 source ~/.bash_profile
を実行することを忘れないでください。
シェルに zsh を使用している場合は、ソースする前にbashcompinit
ロードして起動する必要がある場合があります。 .zshrc
に次の内容を追加します。
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash
WP-CLI のメンテナと貢献者は、一般的なサポートの質問に対応できる時間が限られています。 WP-CLI の現在のバージョンは、公式にサポートされている唯一のバージョンです。
サポートをお探しの場合は、まず次の場所で質問を検索してください。
上記のいずれかの方法で答えが見つからなかった場合は、次のことができます。
#cli
チャンネルに参加して、その時点で対応可能な人とチャットしてください。このオプションは、簡単な質問に最適です。GitHub の問題は、一般的なサポートではなく、既存のコマンドの機能強化とバグを追跡することを目的としています。バグレポートを送信する前に、問題がタイムリーに解決されるようにベスト プラクティスを確認してください。
Twitter でサポートに関する質問をしないでください。 Twitter は、サポートの場として受け入れられません。1) 280 文字未満で会話を行うのは難しい、2) Twitter は、同じ質問を持つ人が以前の会話で答えを検索できる場所ではありません。
覚えておいてください、libre != gratis;オープンソース ライセンスでは、使用および変更する自由が許可されますが、他の人の時間を拘束することは許可されません。敬意を払い、それに応じて期待を設定してください。
コマンドは、WP-CLI 機能の基本単位です。 wp plugin install
(doc) は 1 つのコマンドです。 wp plugin activate
(doc) は別のものです。
WP-CLI は、呼び出し可能なクラス、関数、またはクロージャをコマンドとして登録することをサポートしています。コールバックの PHPdoc から使用法の詳細を読み取ります。 WP_CLI::add_command()
(doc) は、内部およびサードパーティのコマンド登録の両方に使用されます。
/**
* 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 には多数のコマンドが付属しています。カスタム WP-CLI コマンドを作成するのは、見た目よりも簡単です。詳細については、コマンド クックブックを参照してください。内部 API ドキュメントを参照して、カスタム WP-CLI コマンドで使用できるさまざまな便利な関数を見つけてください。
率先して WP-CLI に貢献していただきありがとうございます。 WP-CLI がこれほど素晴らしいプロジェクトであるのは、あなたとあなたの周りのコミュニティのおかげです。
貢献はコードだけに限定されません。チュートリアルを作成したり、地元の交流会でデモを行ったり、他のユーザーのサポートに関する質問を支援したり、ドキュメントを改訂したりするなど、自分の能力に最も適した方法で貢献することをお勧めします。
参加方法について詳しくは、ハンドブックの投稿ガイドラインをよくお読みください。これらのガイドラインに従うことで、プロジェクトの他の貢献者の時間を尊重していることを伝えることができます。次に、彼らは、タイムゾーンを超えて、世界中であなたと仕事をするとき、その敬意に報いるために最善を尽くします。
WP-CLI には、schlessera という 1 人のプロジェクト メンテナーがいます。
場合によっては、プロジェクトを前進させる能力と投資を長期間にわたって証明した貢献者に書き込みアクセスを許可します。
プロジェクトに関する運用の詳細については、ハンドブックのガバナンス文書をお読みください。
Composer.json で定義されたライブラリに加えて、次のプロジェクトのコードまたはアイデアを使用しました。
wp shell
用wp media regenerate
wp search-replace
wp export
用の WordPress-CLI-Exporterwp import
用の WordPress-CLI-Importerwp scaffold plugin-tests
のwordpress-plugin-tests