WP-CLI の基本

WP-CLIを使えば、これまで WordPressの管理画面から ブラウザで操作して設定していたことが、コマンドラインで実行できるようになります。自分でスクリプトを書いて、一括で複数のサイトに適用するといったことが可能になり、設定時間の短縮にもつながります。

  • WP-CLI v0.25.0

wp コマンドのインストール方法 (mac or linux)

サブコマンド一覧表示

wpコマンドでは、サブコマンドを使って、さまざまなリソースを操作することができます。
どのようなサブコマンドがあるかは wp と入力してエンターすることで、一覧表示させることができます。

このように、とても多くの操作ができることがわかります。

サブコマンドの使い方を表示する (help)

例えば、 media サブコマンドの使い方を見る場合:

このように、コマンドの使い方や書式を見ることができますー。

search-replace: DBのデータの検索と置換

search-replaceの書式: ‘検索文字列’ を ‘置換文字列’ で置き換える場合

skip-columns: DBのすべてのテーブルに対して、URLを置換する。ただし、guidは置換の対象外とする。

exportオプション: DBの内容をSQLファイルに書き出す。その際、指定したURLを書き換える。

dry-runオプション: 実際にはDBを変更したくないが、結果がどうなるかを確認した時は dry-run を指定すると良いです

他にも様々なオプションがあるので、以下を参考にしてみてください。
wp search-replace | WP-CLI

テーマ

テーマの一覧をみる

テーマの検索/インストール/削除

プラグイン

プラグインの検索/インストール/有効化/無効化/削除

scaffold

scaffold(スキャッフォールド) とは 「足場」 のことで、よく書くコードを生成してくれるコマンドです。

新規テーマの雛形作成

子テーマの雛形作成

プラグインのスターターコードを生成

プラグインの単体テストの足場を作る

テーマの単体テストの足場を作る (v0.26.0以上)

db

WordPress データベースの検索と置換

terms

カスタム投稿タイプとカスタムタクソノミーの設定


shell

WordPress関数や自作の関数の動作確認をしたい時に便利です。
以下のコマンドを実行すると、shellが起動します。

get_posts関数を実行してみる:

WordPressの設定を確認することもできます:

SQLを実行することもできます:


user

管理者ユーザーを作成

media

サムネを再生成

サムネールのサイズ定義を追加したときなどに、再度サムネールを生成するのに便利。

cache

キャッシュ削除

W3 Total Cacheプラグインのキャッシュを削除

いくつかのWordPressプラグインには、WP-CLIから操作するためのインターフェースが用意されていることがあります。
その場合は、wpコマンドからその機能を呼び出すことができます。以下はW3 Total Cacheのキャッシュを削除する場合です。

WP-CLIに対応しているプラグインは こちらに一例が掲載されています Integrated tools | WP-CLI

package

wp-cli に機能を追加するためのコマンドが package です。
パッケージを管理するためのサブコマンドが揃っています。

  • browse インストール可能なパッケージを検索し、表示します
  • install WP-CLIパッケージをインストールします
  • list インストール済みのパッケージをリストアップします
  • path パッケージをインストールするパスを表示します
  • uninstall パッケージをアンインストールします

インストール方法

例えば hook コマンドをインストールするには以下のようにします:

安定版をインストールする場合は以下のようにします:

githubからインストール:

ダウンロードしたzipファイルからインストール:

詳しくは公式サイトを御覧ください:
wp package install | WP-CLI

WP-CLIの今後ロードマップ

  • 4.7対応
  • REST API 対応
Filed under: コマンドラインTagged with: ,

よく読まれている投稿

No comment yet, add your voice below!


Add a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.