WordPressのコマンドラインインターフェイス

BY admin
|

WP-CLIはWordPressのコマンドラインインターフェイスです。 Webブラウザを使用せずに、プラグインの更新、マルチサイトインストールの構成などを行うことができます。

継続的なメンテナンスは、以下によって可能になります:

現在の安定版リリースはバージョン2.4.0です。 お知らせについては、Twitterで@wpcliをフォローするか、電子メールの更新にサインアップします。 今後のリリースで計画されている内容の概要については、ロードマップを確認してくださ

ビルドステータス問題を解決するための平均時間まだ開いている問題の割合

クイックリンク:|Installing|Support|Extending|Contributing|Credits

WP-CLIを使用すると、多くのアクショwordpressの管理者で実行します。 たとえば、wp plugin install --activate(doc)を使用すると、WordPressプラグインをインストールしてアクティブ化できます:

$ wp plugin install user-switching --activateInstalling 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 --allSuccess: 34 transients deleted from the database.

WP-CLIの使用方法の詳細については、「クイックスタートガイド」を参照してください。 または、有用なコマンドラインユーティリティについて学ぶためにシェルの友人に

すでに基本に慣れていますか？ テーマやプラグインの管理、データのインポートとエクスポート、データベースの検索置換操作の実行などの詳細については、コマンドの完全なリストにジャンプ

インストール

Pharファイルのダウンロードは、ほとんどのユーザーにとって推奨されるインストール方法です。 必要な場合は、代替インストール方法（Composer、Homebrew、Docker）に関するドキュメントも参照してください。

WP-CLIをインストールする前に、ご使用の環境が最小要件を満たしていることを確認してください:

  • WINDOWS環境
  • PHP5.6以降
  • WordPress3.7以降でのサポートが制限されています。 最新のWordPressリリースよりも古いバージョンでは、機能が低下している可能性があります

要件を確認したら、wp-cliをダウンロードしてください。wgetまたはwgetを使用したpharファイルcurl:

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

次に、Pharファイルをチェックして、動作していることを確認します:

php wp-cli.phar --info

コマンドラインからwpと入力してWP-CLIを使用するには、ファイルを実行可能にし、パス内のどこかに移動します。 例えば:

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

WP-CLIが正常にインストールされた場合、wp --infoを実行すると次のようなものが表示されます:

$ wp --infoOS: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_64Shell:/bin/zshPHP binary: /usr/local/bin/phpPHP version: 7.0.22php.ini used: /etc/local/etc/php/7.0/php.iniWP-CLI root dir: /home/wp-cli/.wp-cli/vendor/wp-cli/wp-cliWP-CLI vendor dir: /home/wp-cli/.wp-cli/vendorWP-CLI packages dir: /home/wp-cli/.wp-cli/packages/WP-CLI global config: /home/wp-cli/.wp-cli/config.ymlWP-CLI project config:WP-CLI version: 2.4.0

WP-CLIを更新するには、wp cli update(doc)を使用するか、インストール手順を繰り返します。WP-CLIがrootまたは他のシステムユーザーによって所有されている場合は、sudo wp cli updateを実行する必要があります。

端に人生を生きたいですか？ WP-CLIの最新のnightlyビルドを使用するには、wp cli update --nightlyを実行します。 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 bashcompinitbashcompinitsource /FULL/PATH/TO/wp-completion.bash

サポート

WP-CLIのメンテナと貢献者は、一般的なサポートの質問に対処するための可用性が限られています。 現在のバージョンのWP-CLIは、公式にサポートされている唯一のバージョンです。

サポートをお探しの場合は、まずこれらの会場で質問を検索してください:

  • 一般的な問題とその修正
  • WP-CLIハンドブック
  • WP-CLI GitHub組織で開いているか閉じている問題
  • スレッドは、’WP-CLI’とタグ付けされています。WordPress.org サポートフォーラム
  • WordPress StackExchangeで「WP-CLI」とタグ付けされた質問

あなたは上記の会場のいずれかで答えを見つけられなかった場合は、次のことができま:

  • の#cliチャンネルに参加して、WordPress.org Slackは、その時点で利用可能な人とチャットすることができます。 このオプションは、簡単な質問に最適です。
  • 新しいスレッドを投稿するWordPress.org フォーラムをサポートし、それがコミュニティによって見られているので、それを’WP-CLI’タグを付けます。

GitHubの問題は、一般的なサポートではなく、既存のコマンドの機能強化とバグを追跡するためのものです。 バグレポートを提出する前に、ベストプラクティスを確認して、問題が適時に対処されるようにしてください。

Twitterでのサポート質問はしないでください。 Twitterは、サポートのための許容可能な会場ではありません: 1）280文字未満で会話を保持するのは難しいです、そして2）Twitterはあなたの同じ質問を持つ誰かが以前の会話で答えを検索できる場所ではありません。

覚えておいて、リブレ！=無償;オープンソースライセンスは、あなたに使用し、変更する自由を付与しますが、他の人の時間の約束ではありません。 敬意を表し、それに応じてあなたの期待を設定してください。

拡張

コマンドはWP-CLI機能のアトミックな単位です。 wp plugin install(doc)は1つのコマンドです。 wp plugin activate(ドク)は別です。

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コマンドを作成する方が見た目よりも簡単です。 詳細については、commands cookbookをお読みください。 内部APIドキュメントを参照して、カスタムWP-CLIコマンドで使用できるさまざまな便利な機能を発見してください。

私たちは、あなたがWP-CLIに貢献するためのイニシアチブを取って感謝しています。 WP-CLIがこのような素晴らしいプロジェクトであるのは、あなたとあなたの周りのコミュニティのためです。

貢献は単なるコードに限定されません。 チュートリアルの作成、お近くのミートアップでのデモの提供、他のユーザーのサポートに関する質問の支援、ドキュメントの改訂など、あなたの能力に最も適した方法で貢献することをお勧めします。

あなたが参加することができる方法を徹底的に紹介するためのハンドブックの貢献ガイドラインを読んでください。 これらのガイドラインに従うことは、プロジェクトの他の貢献者の時間を尊重することを伝えるのに役立ちます。 ターンでは、彼らはタイムゾーンを越えて、世界中で、あなたと一緒に作業するときにその尊敬を往復するために最善を尽くします。

WP-CLIにはschlesseraというプロジェクトメンテナがあります。

我々は、プロジェクトを前進させる能力と投資があることを一定期間にわたって実証した貢献者に書き込みアクセス権を付与することがあります。

プロジェクトの詳細については、ハンドブックのガバナンスドキュメントをお読みください。

json、我々は次のプロジェクトからのコードやアイデアを使用しています:

  • wp shell
  • wp media regenerate
  • wp search-replace
  • WordPress-CLI-Exporter forwp export
  • WordPress-CLI-Importer forwp import
  • WordPress-CLI-Importer Forwp import
  • WordPress-CLI-Importer Forwp media regenerate
  • サムネイルを再生成するための多くのもの
  • Wpshell forwp media regenerate
  • Search-Replace-DB forwp search-replace
  • WordPress-CLI-Importer forwp import
  • wordpress-plugin-tests forwp scaffold plugin-tests