実務で使える!WordPressのWP-CLIの使い方について徹底解説(コマンド解説付き)
みなさんこんにちは!エンジニアの高澤です!
今回はWP-CLIの使い方と基礎知識について解説していきたいと思います。
WP-CLIは、開発者の方にとって非常に便利なツールのひとつといっても過言ではありません。別に知っていなくても困らないのではないか?とおっしゃる方もいらっしゃるかもしれませんが、このWP-CLIを使えるようになっておくと業務を効率化できる可能性があります。
Webサイト制作でWordPressサイトを構築しているエンジニアや、WordPressのテーマやプラグイン開発者の方はもちろん、ウェブサイト運営者の方にとって有益な情報となっておりますので、よろしければぜひお仕事などに当記事をご活用いただけましたら幸いです。
WP-CLIとは
WP-CLI (WordPress Command Line Interface) とは、WordPressサイトをコマンドラインで管理するためのツールのことをいいます。
通常、WordPressの管理(画面操作など)はブラウザを介して行いますが、WP-CLIを使えばコマンドラインから素早く作業が可能になります。
例えば、テーマやプラグインのインストールや更新、ユーザーの管理、データベースの操作なども、数行のコマンドで実行できます。これにより、複数の操作を一度に実行でき、特に運用管理が多い大規模サイトや、頻繁に作業が発生するサイトの管理において非常に便利です。
また、WP-CLIはWordPressのAPIを活用しているため、ブラウザで行う作業と同じく安全に操作できるようになっています。初心者から開発者まで、手作業を減らしたい人や効率的に作業を進めたい人におすすめのツールです。
WP-CLIの基礎
WP-CLIの基本的な使い方を理解することで、WordPressの管理作業が効率化します。
まず、WP-CLIを使うためにはサーバーやローカル環境にインストールする必要があります。インストール手順は公式サイトに詳細が記載されているため、それに従ってセットアップを行いましょう。
WP-CLIの操作はすべてコマンドラインから行います。一般的には以下のような形式で入力し、コマンドの実行にはWordPressサイトのルートディレクトリに移動してから行います。
wp <サブコマンド> <オプション>
各サブコマンドは、目的に応じた操作を行うために存在します。たとえば、WordPressのバージョン確認は wp core version
というコマンドを使います。
このように、コマンド入力であらゆる操作ができるため、手作業に比べて非常に効率的です。
WP-CLIのコマンド例
ここで簡単にWP-CLIのコマンドの例について触れておきたいと思います。
事前にWP-CLIについて少し慣れておくことでこの後の解説の飲み込み速度がまったく違うので、ここで簡単にイメージしておきましょう。
コマンド用途例 | 内容 |
---|---|
インストールと更新 | テーマやプラグインのインストールや更新が簡単にでき、たとえば wp plugin install や wp theme update などのコマンドを使います。 |
サイトの状態確認 | wp site status コマンドでサイトの概要や状態をすばやく確認できます。 |
データベース操作 | wp db を使えば、データベースのバックアップやインポート、テーブルの最適化も実行できます。 |
これらのコマンドにオプションを組み合わせることで、特定の設定を適用したり、目的に応じて柔軟な操作が可能です。
WP-CLIのメリット
次にWP-CLIのメリットについて解説していきたいと思います。
ここでしっかりメリットについて理解しておけば、仕事に導入する際に上長などにロジックを持った上で導入の提案できたり、ご自身の開発に取り入れるべきかを判断できたりするための良い材料になります。
WP-CLIのメリットは、WordPressサイトの運営・管理・開発の作業を効率的かつ迅速に行えることにあります。ここではWP-CLIの主要なメリットを挙げて解説させていただきます。
操作の効率化と時間短縮
WP-CLIは、コマンドラインから直接操作できるため、WordPressの管理画面に毎回アクセスする必要がありません。
プラグインのインストールや更新、テーマの切り替え、設定の変更などが数秒で完了するため、大幅に時間が短縮できます。例えば、大量の投稿を一括で公開・下書きに戻したい場合や、プラグインを一括更新したい場合などに特に便利です。
繰り返し作業の自動化
シェルスクリプトと組み合わせることで、定期的に必要な作業を自動化できます。
例えば、バックアップの取得やデータベースの最適化など、面倒な作業もコマンドでまとめて設定し、定期的に実行させることで作業負担が減り、運用管理がスムーズになります。
エラーの軽減
操作ミスや手動の操作に伴うエラーが減ります。
コマンドで明確な手順を定義できるため、作業をマニュアル化しやすく、チーム内での作業の統一や引き継ぎが容易になります。例えば、新しいスタッフでも同じ手順を実行することで、操作ミスが軽減されます。
リモート環境での操作が容易
WP-CLIは、サーバーやリモート環境でWordPressを管理する場合にも便利です。
SSHを使ってサーバーにアクセスし、コマンドを実行することで、リモートからでも迅速に対応できます。開発者にとって、クライアントのサイトやテスト環境など、複数の環境に対応する際に役立ちます。
高度な機能に素早くアクセス可能
通常の管理画面では行えない高度な設定や、特定の開発用途に特化した操作が可能です。
例えば、wp search-replace
コマンドを使ってデータベースの内容を一括で置換したり、テーマのカスタムコードのテストを瞬時に行うこともできます。これにより、開発・運用の柔軟性が高まります。
このように、WP-CLIを活用すると、作業効率の向上、作業の自動化、エラーの軽減が実現でき、運用・開発環境が大幅に改善されます。
特に、複数のサイトを管理している場合や、定期的なメンテナンス作業がある場合には、その効果を最大限に感じられるでしょう。
WP-CLIの使い方
それでは、WP-CLIの使い方について解説していきたいと思います。
WP-CLIの使い方は、コマンドラインを通じてWordPressを効率的に管理することを目指しており、サイト管理者や開発者にとって便利なツールです。以下に、インストール方法と基本的な使い方を解説します。
WP-CLIのインストール
まず、WP-CLIを使うには、サーバー環境やローカル環境にインストールする必要があります。
ターミナルを開いていただき、以下のコマンドを実行してください。
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
実行したら、以下のようにターミナルにて出力されるはずです。これでインストール自体は完了していることが確認できました。
takasawashou@MacBook-Pro-64 ~ % curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 6882k 100 6882k 0 0 10.1M 0 --:--:-- --:--:-- --:--:-- 10.1M
上記が確認できたら、以下のコマンドでWP-CLIが正しくインストールされていることを確認してみましょう。
php wp-cli.phar --info
以下のような出力がされていれば、無事WP-CLIが正しくインストールされていることが確認できます。
takasawashou@MacBook-Pro-64 ~ % php wp-cli.phar --info
OS: Darwin 24.0.0 Darwin Kernel Version 24.0.0: Tue Sep 24 23:36:30 PDT 2024; root:xnu-11215.1.12~1/RELEASE_X86_64 x86_64
Shell: /bin/zsh
PHP binary: /usr/local/Cellar/php/8.3.13_1/bin/php
PHP version: 8.3.13
php.ini used: /usr/local/etc/php/8.3/php.ini
MySQL binary:
MySQL version:
SQL modes:
WP-CLI root dir: phar://wp-cli.phar/vendor/wp-cli/wp-cli
WP-CLI vendor dir: phar://wp-cli.phar/vendor
WP_CLI phar path: /Users/takasawashou
WP-CLI packages dir:
WP-CLI cache dir: /Users/takasawashou/.wp-cli/cache
WP-CLI global config:
WP-CLI project config:
WP-CLI version: 2.11.0
takasawashou@MacBook-Pro-64 ~ %
インストール中エラーが出た時の対処法
もし「php wp-cli.phar –info」実行時に上記結果ではなく以下の結果が出力された方は、必要なライブラリが見つからないため、PHPが正常に動作していないことが原因でエラーが起こってしまっている可能性があります。
このエラーは、特に ICU(International Components for Unicode)ライブラリが正しくインストールされていないか、バージョンが一致していない場合に発生します。
takasawashou@MacBook-Pro-64 ~ % php wp-cli.phar --info
dyld[45998]: Library not loaded: /usr/local/opt/icu4c/lib/libicuio.74.dylib
Referenced from: <8DAE88FD-8ED0-3140-A6A4-234664519823> /usr/local/Cellar/php/8.3.10/bin/php
Reason: tried: '/usr/local/opt/icu4c/lib/libicuio.74.dylib' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/usr/local/opt/icu4c/lib/libicuio.74.dylib' (no such file), '/usr/local/opt/icu4c/lib/libicuio.74.dylib' (no such file), '/usr/local/Cellar/icu4c@75/75.1/lib/libicuio.74.dylib' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/usr/local/Cellar/icu4c@75/75.1/lib/libicuio.74.dylib' (no such file), '/usr/local/Cellar/icu4c@75/75.1/lib/libicuio.74.dylib' (no such file)
zsh: abort php wp-cli.phar --info
上記エラーを解決するには、以下の2点をお試しいただくと解決する可能性があります。
ICUライブラリを再インストールする
Homebrewを使っている場合は、次のコマンドを実行してICUライブラリを再インストールできます。
brew reinstall icu4c
PHPの再インストール
ICUライブラリを再インストールした後、PHPも再インストールすることで依存関係をリフレッシュできます。
brew reinstall php
これで問題が解決することが多いですが、もし問題が続く場合は、エラーコードをChatGPTなどAIツールを使用するなどしてご確認いただけると解決する可能性がありますので、おすすめいたします。
WP-CLIをシステム全体で使用可能にする
次に以下のこの2つのコマンドを実行することで、wp-cli.phar
をシステム全体から簡単に使えるように設定していきます。
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp
上記コマンドについて詳しく解説いたします。
chmod +x wp-cli.phar
- このコマンドは
wp-cli.phar
ファイルに「実行権限 (executable permission)」を付与します。 chmod
はファイルの権限を変更するコマンドで、+x
は「実行可能」にするオプションです。- これにより、
wp-cli.phar
が直接実行できるようになります。
sudo mv wp-cli.phar /usr/local/bin/wp
mv
はファイルを移動するコマンドです。ここではwp-cli.phar
を/usr/local/bin/
ディレクトリに移動しています。/usr/local/bin
はシステム全体で使用できるコマンドを置くディレクトリのひとつです。- 移動後、ファイル名を
wp
に変更しています。これにより、コマンドラインで「wp
」と入力するだけでwp-cli
を使えるようになります。
この設定を実行すると、WordPress CLI コマンドを以下のように簡単に呼び出せるようになります。
wp core version
これにより、php wp-cli.phar
と毎回入力する手間が省け、システム全体で使える便利なコマンドとして利用できるようになります。
試しに、wp-envを使って立ち上げたローカル環境のWordPressに対して wp core version を実行してみましょう。
wp-envでのWordPressローカル環境構築の方法については以下の記事からご確認できますので、よろしければご確認ください。
wp-envで立ち上げたWordPress本体ファイルのトップディレクトリにパスを移動してください。
MacOSのPCをご利用の方は、以下のようなパスのイメージになるかと思います(以下はMacOSを想定しておりますので、Windows環境の方はご自身でパスをご確認ください)。
あくまで参考程度のパスになりますので、必要な箇所を書き換えなければパスを正しく移動させることはできません。
# WordPress環境「http://localhost:8889/」の場合
cd /Users/takasawashou/.wp-env/acad1a2b221aa7bc9d03005a81cbeb36/WordPress
# WordPress環境「http://localhost:8889/」の場合
cd /Users/takasawashou/.wp-env/acad1a2b221aa7bc9d03005a81cbeb36/tests-WordPress
書き換えていただく部分としては、「takasawashou」の部分と「acad1a2b221aa7bc9d03005a81cbeb36」の部分になります。
「takasawashou」はご自身のMacのPCのユーザー名になります(Macユーザーにとって通常のよく見るパスです)。
そして「acad1a2b221aa7bc9d03005a81cbeb36」はwp-envによって自動生成される一時的な環境ファイルやディレクトリの一部として自動生成されたユニークな識別子 (ハッシュ値) です。
環境を識別するために自動生成される ID で、環境ごとに異なる文字列が割り当てられます。このディレクトリには、下図のように、コンテナに関連するデータや設定ファイル、データベース情報などが保存されるため、特定の開発環境やプロジェクトに関連したファイルを管理するために役立ちます。
補足の説明が長くなりましたが、ターミナルで上記どちらかのパスを実行していただき、現在のパスをWordPress本体ファイルのトップディレクトリに移動してください。
そしてちなみに、上記パスの末尾の「WordPress」と「tests-WordPress」は、それぞれwp-envで生成されたWordPress本体ファイルになります。
カレントディレクトリ(現在のディレクトリパスの位置)を「WordPress」もしくは「tests-WordPress」に移動したら、以下のコマンドを実行してください。
wp core version
すると以下のようにバージョンが出力されるかと思います。
takasawashou@MacBook-Pro-64 tests-WordPress % wp core version
6.6.2
これでWP-CLIを使えるようになりました。お疲れ様でした!
あとはご自身でこの後解説するコマンドや、公式ドキュメントに公開されているコマンド集をご確認いただき、業務をたくさん効率化してください。
ちなみに、WP-CLIの詳しいインストール手順は以下のWordPress公式サイトのガイドが参考になります。よろしければ合わせてご確認ください。
WP-CLIのコマンドの使い方
それではWP-CLIのコマンドの使い方を解説したいと思います。
WP-CLIでのコマンド入力は、以下の形式で行います。
wp <サブコマンド> <オプション>
この形式で入力することで、指定した機能を実行します。
例えば、以下は基本的な使い方の例です。
WordPressのバージョンを確認する
wp core version
現在のWordPressバージョンをコマンドラインに表示します。
プラグインをインストールする
wp plugin install <plugin-name>
<plugin-name>
の部分にプラグイン名を指定して入力すると、そのプラグインがインストールされます。
テーマの有効化
wp theme activate <theme-name>
<theme-name>
にテーマ名を指定し、現在のテーマを切り替えることができます。
コマンドのヘルプ機能を活用する
WP-CLIでは、各コマンドに対するヘルプも確認できます。例えば、wp plugin
コマンドの詳細を知りたい場合は、以下のように入力するとヘルプが表示されます。
wp help plugin
これにより、コマンドの使い方やオプションを確認できるため、操作に迷ったときに便利です。
使いこなしのコツ
WP-CLIは、よく使うコマンドをシェルスクリプトにまとめたり、wp config
や wp db
コマンドを活用して設定管理やバックアップを効率化することで、運用のスピードを大幅に向上させられます。また、複数のコマンドを続けて実行し、一連の処理を自動化することで、作業の効率化に役立ちます。
WP-CLIを習得して使いこなすことで、手間のかかる操作を減らし、サイト運営や開発の生産性が向上します。
WP-CLIのコマンド一覧
それではWP-CLIのコマンド一覧について解説いたします。
WP-CLIには非常に多くのコマンドが用意されており、以下は代表的なコマンドの種類になります。
- wp core – WordPressのコア機能に関するコマンド。
- wp plugin – プラグインの管理。
- wp theme – テーマの管理。
- wp user – ユーザーの管理。
- wp db – データベースの操作。
- wp option – サイトオプションの管理。
- wp post – 投稿の管理。
- wp search-replace – 文字列の置換。
上記の種類に関するコマンドについて、以下いくつか掲載させていただきます。
「<〇〇>
」の部分はご自身で任意に適切なものを当てはめてコマンドを修正した上で実行してください。
wp core version | 現在のWordPressバージョンを確認。 |
wp core update | WordPress本体の更新。 |
wp plugin install <plugin-name> | プラグインのインストール。 |
wp plugin update <plugin-name> | プラグインの更新。 |
wp plugin delete <plugin-name> | プラグインの削除。 |
wp theme install <theme-name> | テーマのインストール。 |
wp theme update <theme-name> | テーマの更新。 |
wp theme activate <theme-name> | テーマの有効化。 |
wp user create <username> <email> | 新しいユーザーの作成。 |
wp user delete <username> | ユーザーの削除。 |
wp db export | データベースのエクスポート(バックアップ)。 |
wp db import <filename> | データベースのインポート。 |
wp db optimize | データベースの最適化。 |
wp option get <option_name> | オプションの値を取得。 |
wp option update <option_name> <value> | オプションの値を更新。 |
wp post create –post_title=”Title” –post_content=”Content” | 新しい投稿を作成。 |
wp post delete <post_id> | 投稿の削除。 |
wp search-replace 'old-string' 'new-string' | データベース内の文字列を一括で置換。 |
これらのコマンドを組み合わせることで、ブラウザ操作に頼らずにさまざまな管理が可能です。WP-CLIを使いこなすことで、作業効率が大幅に向上しますので、まずはよく使うコマンドから慣れていくとよいでしょう。
WP-CLI関連の公式ドキュメント・公式サイト
最後に、WP-CLI関連の公式ドキュメント・公式サイトについてご紹介させていただきます。
例えば「WordPress CLI コマンドリファレンスページ」に関してはコマンドが全て網羅されているため、業務中には必須のページとなるかと思います。
WP-CLIに関するページは、主に以下のページになるかと思います。
- WP-CLI公式サイト
- WordPress CLI コマンドリファレンスページ
それぞれ解説させていただきます。
WP-CLI公式サイト
WP-CLI公式サイトは、WordPressのコマンドラインインターフェース「WP-CLI」に関する情報を提供している日本語のサイトです。
このサイトでは、WP-CLIを使って効率的にWordPressを管理するためのガイドやコマンドのリファレンスが紹介されています。
WordPress CLI コマンドリファレンスページ
WordPress CLI コマンドリファレンスページでは、WP-CLIのすべてのコマンドとその詳細な使い方が提供されています。
WP-CLIのすべてのコマンドが掲載されているので、WP-CLIを使う開発者は業務中に大体このページを開きつつ作業することになるかと思います。
https://developer.wordpress.org/cli/commands
下図のように、各コマンドがカテゴリ別に一覧化されており、目的別に必要なコマンドを探しやすくなっています。
例えば、wp plugin
、wp theme
、wp user
などの主要カテゴリに分かれており、それぞれのサブコマンドと詳細な使い方が記載されています。
それぞれWP-CLIについてかなり豊富な情報源となるかと思いますので、フルに活用していきましょう。
まとめ
今回はWP-CLIの使い方と基礎知識について解説いたしました。
WP-CLIは、WordPressをコマンドから操作できる非常に便利なツールのひとつといっても過言ではありません。
別に知っていなくても困らないのではないか?とおっしゃる方もいらっしゃるかもしれませんが、このWP-CLIを使えるようになっておくと管理画面をクリック操作でいちいち操作する手間が省けるため、業務を効率化できる可能性が大いにあります。
このWP-CLIは、Webサイト制作でWordPressサイトを構築しているエンジニアや、WordPressのテーマやプラグイン開発者の方はもちろん、ウェブサイト運営者の方にとって有益な情報となっておりますので、よろしければぜひ繰り返し当記事をご活用いただけましたら幸いです。
お気軽に皆さんのご要望をお聞かせください!
どんなに些細なことでも構いません!よろしければ記事や当サイトへの「こんな記事があったら仕事とかで役に立つな〜」や「こうだったらもっと役に立つのに!」といったようなご要望等をお気軽にお聞かせください!今後のサービス改善にお役立てさせていただきます!
例1)Reactの技術記事を書いてほしい!
例2)WordPressの使い方とかを初心者向けに解説してほしい!...など