WP-CLIコマンド構造のガイド

WordPressコマンドラインインターフェイス（WP-CLI）は、開発ワークフローを改善するためのすばらしいツールです。 コマンドがどのように構成されているかを理解することは、WP-CLIを最大限に活用するための鍵です。 この記事では、親コマンドとサブコマンド、およびパラメーターとスイッチの使用方法を含む、WP-CLIコマンドの構造化方法を学習します。

コマンドの作成に取り掛かる前に、WP-CLIをインストールする必要があります。 正確な方法はOSによって異なりますが、WP-CLIのインストールと構成に関するガイドには必要なものがすべて揃っています。

親コマンドとサブコマンド

ほとんどすべてのWP-CLIコマンドは同じように構成されています。 コアのWordPressインストールを操作するためのwp coreなど、機能のより大きな領域ごとに親コマンドがあります。 これらの各親コマンドは、いくつかの異なるサブコマンドで使用でき、少なくとも1つで使用する必要があります。

親コマンドは基礎を築く

親コマンドは、それ自体では有用なことは何もしません。 たとえば、 wp configを単独で使用しようとすると、次のように表示されます。

〜$ wp config
使用法：wp config create --dbname = --dbuser = [--dbpass = ] [--dbhost = ] [--dbprefix = ] [--dbcharset = ] [--dbcollat​​e = ] [--locale = ] [--extra-php] [--skip-salts] [--skip-check] [--force] [--config-file = ][--安全でない]
   または：wp config delete [--type = ] [--config-file = ]
   または：wp config edit [--config-file = ]
   または：wp config get [--type = ] [--format = ] [--config-file = ]
   または：wpconfigには[--type = ] [--config-file = ]
   または：wp config list [ ...] [--fields = ] [--format = ] [--strict] [--config-file = ]
   または：wp config path
   または：wp config set [--add] [--raw] [--anchor = ] [--placement = ] [--separator = ] [--type = ] [--config-file = ]
   または：wp config shuffle-salts [ ...] [--force] [--config-file = ][--安全でない]

特定のコマンドの詳細については、「wphelpconfig」を参照してください。

それだけで、 wp configコマンドをどのように使用するかについてのかなり良い手がかりが得られます。 そのアドバイスに従い、 wp help configと入力すると、さらに理解を深めることができます。

名前

  wp config

説明

  wp-config.phpファイルを生成して読み取ります。

概要

  wp config

サブコマンド

  createwp-config.phpファイルを生成します。
  deletewp-config.phpファイルから特定の定数または変数を削除します。
  editシステムエディタを起動して、wp-config.phpファイルを編集します。
  getwp-config.phpファイルで定義されている特定の定数または変数の値を取得します。
  has特定の定数または変数がwp-config.phpファイルに存在するかどうかをチェックします。
  list wp-config.phpファイルで定義されている変数、定数、およびファイルインクルードを一覧表示します。
  pathwp-config.phpファイルへのパスを取得します。
  setwp-config.phpファイルで定義されている特定の定数または変数の値を設定します。
  shuffle-saltswp-config.phpファイルで定義されているソルトを更新します。

グローバルパラメータ

  --path =

コアWP-CLIインストールには、合計で40を超える親コマンドがあります。 WooCommerceやBuddyPressなどの人気のあるプラグインには、独自の親コマンドが追加されているため、WordPressのインストールにはさらに多くのコマンドが含まれる場合があります。 ほとんどの場合、 wp helpに続けて親コマンドの名前を入力することで、コマンドの使用方法を見つけることができます。

それらがどのようにグループ化されているかを少し理解すると、WP-CLIの使用方法を学ぶときに役立ちます。 WP-CLIコマンドは、ほとんどの場合、コマンドで単数名詞を使用することに注意してください。 たとえば、ユーザー管理の親コマンドの名前は、「 wp user 」ではなくwpuserです。 あなたがそれを覚えている限り、あなたはあなたの直感がしばしば正しいことに気付くでしょう。 コメントを管理するためのコマンドは、実際、 wp commentであり、 wp cronは、WP-Cronのスケジュールとイベントを管理するために使用するコマンドです。

以下に、最も一般的に使用される親コマンドのいくつかを含むチートシートを示します。

サブコマンドは方向性を与える

前に述べたように、これらのコマンドはどれも実際には単独では機能しません。 また、どこにでも移動する場合は、サブコマンドを指定する必要があります。 タブ補完を設定することを強くお勧めします。 これにより、サブコマンドを簡単に確認できます。 たとえば、タブ補完を使用すると、 pluginのサブコマンドを確認できます。

 $ wp plugin [TAB] activate get list toggle auto-updates install path uninstall deactivate is-active search update delete is-installed status verify-checksums

サブコマンドを指定せずにEnterキーを押すと、WP-CLIに追加のヘルプを表示するように求められます。

 $ wp plugin usage: wp plugin activate [<plugin>...] [--all] [--network] or: wp plugin auto-updates <command> or: wp plugin deactivate [<plugin>...] [--uninstall] [--all] [--network] or: wp plugin delete [<plugin>...] [--all] or: wp plugin get <plugin> [--field=<field>] [--fields=<fields>] [--format=<format>] or: wp plugin install <plugin|zip|url>... [--version=<version>] [--force] [--activate] [--activate-network] [--insecure] ....

上記のヘルプテキストでのパラメータの表示方法の違いに注意してください。 < >マークでカプセル化されているものもあれば、接頭辞として二重ダッシュが付いているものもあります-- 。 それは偶然ではありません。 それらは異なるタイプのパラメーターです。 後で話を戻します。

WP-CLIは、各サブコマンドとそれが期待するパラメーターについてもう少し詳しく教えてくれることが多いという点で、うまく機能します。 これは、すべての組み込みWP-CLIコマンド全体で非常に一貫しています。 予想されるすべてのパラメーターを使用して完全なコマンドを入力できない場合は常に、予想されていた内容について詳しく説明します。

人気のあるコマンドのWP-CLIチートシート

以下のチートシートは、いくつかのより一般的なサブコマンドとそれらが使用する親コマンドを示しています。 ここにリストされているものよりもはるかに多くのサブコマンドが利用可能です。 wp commentなどの一部の親コマンドには12をはるかに超えるサブコマンドがありますが、 wp cronなどの他のコマンドにはほんの数個しかありません。

WPコア

WP構成

WPテーマ

WPプラグイン

パラメータとスイッチ

親コマンドとサブコマンドに加えて、ほとんどのコマンドは、何か便利なことを実行できるようにするために、少なくとも1つのパラメーターを必要とします。 たとえば、プラグインをインストールする場合は、インストールするプラグインを指定する必要があります。 当然、プラグインのアクティブ化または削除についても同じことが言えます。

WP-CLIで使用するパラメーターには、基本的に3つのタイプがあります。順序付きパラメーター、名前付きパラメーター、およびスイッチです。

順序付けされたパラメーター

コマンドに複数の通常のパラメーターが必要な場合、コマンドが機能するには、それらを常に正しく順序付ける必要があります。 これが、それらが順序付きパラメータと呼ばれる理由です。 それらは常に単一のスペースで区切られます。 パラメータ値自体にスペースが含まれている場合は、引用符で囲む必要があります。

コマンドのヘルプテキストでは、順序付けられたパラメーターは<と>で囲まれています。 パラメータなしでwp post getを使用しようとする次の例では、 idが<と>で囲まれているため、順序付けられたパラメータであることがわかります。

 $ wp post get usage: wp post get <id> [--field=<field>] [--fields=<fields>] [--format=<format>]

名前付きパラメーター

WP-CLIは、名前付きパラメーターでも多く機能します。 これらは任意の順序で指定できます。 名前付きパラメーターは、名前の前の二重ダッシュと、名前と値の間に等号が存在することによって認識されます。

たとえば、上記のwp post getのヘルプテキストを見ると、 formatパラメータとfieldsパラメータの前に二重ダッシュが付いていることがわかります。 このようにして、これらがこのコマンドの名前付きパラメーターであることがわかります。

注文は本当に重要ではありません：

 # This will get the the title field for post id 1 in JSON format $ wp post get 1 --fields=title --format=json # This is the same command, order of named parameters doesn't matter: $ wp post get 1 --format=json --fields=title # This is also exactly the same, you can put named parameters before the ordered ones: $ wp post get --format=json --fields=title 1

スイッチ

真/偽のタイプ値を示すためにのみ使用される名前付きパラメーターもあります。 これらはスイッチと呼ばれ、値を指定する必要はありません。 それらをコマンドラインに追加すると、「真」を意味すると理解されます。 それらを省略すると、「偽」になります。

おそらく、これはいくつかの例で最もよく説明されています。

 # Passing "hello-dolly" as regular ordered parameter $ wp plugin activate hello-dolly # Passing a regular ordered parameter with spaces requires quotes $ wp plugin search "WP Offload Media" # Passing the value 'json' to the named parameter 'format' $ wp plugin list --format=json # Setting the 'quiet' switch to true $ wp plugin activate hello-dolly --quiet

それほど複雑ではありませんねこれは、コマンドラインツールのほとんどの標準です。 しかし、もう1つ詳細を追加しましょう。

グローバルな名前付き引数

名前付き引数は、多くのWP-CLIコマンドがそれらを使用するという意味でグローバルにすることができ、使用すると常に同じ動作をします。

他の名前付き引数は、1つの特定のコマンドにのみ意味があります。 このタイプの名前付き引数は、基本的には単なる名前付きパラメーターです。 上記の例では、 --quietパラメーターはすべてのコマンドに同じように影響するため、グローバルです。 ただし、 --formatパラメーターは、すべてのコマンドに意味があるわけではないため、グローバルとは見なされません。

WP-CLIコマンドの使用方法

例として、 wp-pluginを使用してWordPressプラグインをインストールしてアクティブ化する方法を見てみましょう。 これは、ユーザーの管理に加えて、新しいWP-CLIユーザーが最初に学びたい分野の1つです。 コマンドラインからプラグインを管理することにそれほど興味がない場合でも、このセクションを読んで、WP-CLIを使用するための準備を整えておく価値があります。

WordPressリポジトリから新しいプラグインをインストールするのは非常に簡単です。 プラグインをインストールするには、親コマンド（ wp plugin ）、サブコマンド（ install ）、および順序付きパラメーター（プラグインの公式スラグ）が必要です。 プラグインをアクティブ化するには、同様のコマンドを使用しますが、サブコマンドが異なります（ activate ）。

すべてをまとめると、次のように表示されます。

 # Installing a plugin $ wp plugin install hello-dolly Installing Hello Dolly (1.7.2) Downloading installation package from https://downloads.wordpress.org/plugin/hello-dolly.1.7.2.zip... The authenticity of hello-dolly.1.7.2.zip could not be verified as no signature was found. Unpacking the package... Installing the plugin... Plugin installed successfully. Success: Installed 1 of 1 plugins. $ wp plugin activate hello-dolly Plugin 'hello-dolly' activated. Success: Activated 1 of 1 plugins.

ご覧のとおり、プラグインのインストールとアクティブ化は、Webインターフェイスを使用してプラグインをインストールする場合と同様に、WP-CLIでは2つの別個のものです。 ただし、プラグインをインストールして直接アクティブ化することは非常に一般的であるため、WP-CLIには両方を同時に実行する方法があります。

 # Installing AND activating a plugin in one go $ wp plugin install --activate hello-dolly

トリッキーな部分の1つは、必要なプラグインに適したスラッグを見つけることです。 すべてのプラグインは公式のスラッグで識別されますが、多くの場合、スラッグはプラグインの正式な名前とリモートで類似していません。 非常に人気のあるYoastSEOプラグインには、スラッグwordpress-seo seoがあります。 独自のプラグインWPOffloadMediaのスラッグは、 amazon-s3-and-cloudfrontです。

スラッグは、プラグインがWordPressプラグインリポジトリに最初に受け入れられたときに割り当てられ、唯一の一意の識別子です。 プラグインの名前が変わっても、スラッグは同じままです。 プラグインリポジトリのWebページにいつでもアクセスして、プラグインを検索し、URLのパスを確認できます。

それは機能しますが、フィネスが不足していて、ターミナルからあなたを連れ出します。 WP-CLIのsearchサブコマンドを使用してこれを行う適切な方法は次のとおりです。

 wp plugin search "wp offload media" --per-page=1 --fields=name,slug Success: Showing 1 of 66 plugins. +-----------------------------------------------------------------------+--------------------------+ | name | slug | +-----------------------------------------------------------------------+--------------------------+ | WP Offload Media Lite for Amazon S3, DigitalOcean Spaces, and Google | amazon-s3-and-cloudfront | | Cloud Storage | | +-----------------------------------------------------------------------+--------------------------+

プラグインの管理について詳しく知りたい場合は、WP-CLIに関する後の投稿で、 wp pluginコマンドの本質的な側面すべてについて詳しく説明します。 今のところ、パラメータの使用を示す方法として使用しています。

まとめ

WP-CLIを開発ワークフローに統合することで得られる最大のメリットは、作業がどれだけ速くなるかということです。 事実上、WordPress管理者からできることはすべて、コマンドラインを使用して短時間で実行できます。

基本を理解したら、これなしでは生きていけないWP-CLIパッケージのリストを使用してWP-CLIをさらに進めることができます。

コマンド、サブコマンド、およびパラメーターがどのように構成されているかを理解することは、WP-CLIに慣れるための鍵です。 私の意図は、あなたが自分で実験を始めるために必要な基本的な知識をあなたに提供することです。 WP-CLIコマンド、パラメーター、またはその他のWP-CLI関連の構造について質問がある場合は、コメントでお知らせください。