[wp-cli] 公式サイトの歩き方とヘルプページの実行方法

wp-cli公式サイトはドキュメントが非常に充実しています。英語のサイトですが、コマンドの解説などは平易な英語で書かれているので、一読されることをおすすめします。

http://wp-cli.org/

wp-cliのヘルプページを見る

wp-cli インストール後はほとんどの操作をコマンドラインで行うことができます。逆に言えば、ファイルを書いたりする必要はほとんどありません。なので、 wp-cli のコマンド解説のページを見ることが多くなるでしょう。

例えば、投稿の管理をしたい場合は「post」からサブコマンドを実行することになります。トップページで「Commands」をクリックし、コマンドの一覧から「post」をクリックすると、create delete edit generate get list meta term updateのサブコマンドが表示されるので、今回はlistサブコマンドのヘルプを見てみることにしましょう。

ページの一番下にコマンドの例示がありますので、こちらも参考になるかと思います。1点気をつけなければいけないのは、サンプルのコマンドでは –path=〜〜 が書かれていません。 wp-cli のお約束として、 WordPressをインストールしているディレクトリを –path=〜〜 という引数に与えるか、そのディレクトリにcdして実行するかのどちらかであることを理解しましょう。

ホームディレクトリで –path=〜〜 を与えずに実行した場合、こんなエラーが表示されます。

さくらのレンタルサーバーは、ホームディレクトリの下にある www ディレクトリが公開されるので、 –path= へ引数を与える場合はこうやって実行します。

または、 www ディレクトリへ移動した後であれば、 –path=〜〜 の引数をつけなくても構いません。


wp-cliのコマンドラインからヘルプを表示する

SSHクライアントとWEBブラウザを行ったり来たりするのが面倒!という場合は、wpコマンドからもヘルプを呼び出すことができます。引数をつけずに「wp」と実行するだけで、コマンド名、説明、書式、サブコマンド、設定値で使えるものの一覧が表示されます。

縦に長いので、「J」キーを押すと下に1行、「K」キーを押すことで上に1行スクロールします。スペースキーを押すことでページ単位で下にスクロールすることができます。

同様に、サブコマンドのヘルプも表示することができます。

wpコマンドのヘルプ表示は、どのディレクトリで実行しても –path=〜〜 の引数は不要です。

Web担当者のためのWordPressがわかる本 あらゆるビジネスサイトで使える企画・設計・制作・運用のノウハウ