wp-cli

WordPressをコマンドラインから操作できるwp-cli (http://wp-cli.org/) を入れてみた。

インストール

ファイルを拾ってきて実行権をつけてpathの通った場所に置くだけ。

–no-verify-peerオプションをつけるのは、何もつけないと次のようなSSLエラーが出るため。

オプションをつける代わりに、環境変数SSL_NO_VERIFY_PEERに1を設定しておいても良い。次のように動作確認。

コマンド

次のように入力するとヘルプが表示される。

同様にしてサブコマンドもすべてヘルプ表示できる。

コマンド名 説明
cache キャッシュの管理
cap 権限の管理
cli WP-CLI自身についての情報表示
comment コメントの管理
core WordPressのダウンロード、インストール、アップデートなど
db 基本的なデータベース操作
eval ロード後に任意のPHPコードを実行
eval-file ロード後にPHPファイルを実行
export WXRファイルにエクスポート
help 自分自身のコマンドに関するヘルプを表示
import WXRファイルをインポート
media 添付ファイルを管理
menu メニューの作成、割り当て、削除、一覧表示
network マルチサイトのネットワーク管理
option オプションの管理
plugin プラグインの管理
post 投稿の管理
rewrite rewriteルールの管理
role 権限グループの管理
scaffold 投稿型、タクソノミーなどに関するコード生成
search-replace データベース中の文字列の検索/置換
shell インタラクティブなPHPコンソール
sidebar サイドバーの管理
site サイト全体の操作
super-admin 特権管理者の追加、削除、一覧表示など
term タームの管理
theme テーマの管理
transient transientを管理
user ユーザーを管理
widget ウィジェットを管理

コマンド詳細

cache

使用例

サブコマンド 説明
add オブジェクトキャッシュに値を追加する。
decr オブジェクトキャッシュの値をデクリメントする。
delete オブジェクトキャッシュから値を削除する。
flush オブジェクトキャッシュをフラッシュする。
get オブジェクトキャッシュの値を取得する。
incr オブジェクトキャッシュの値をインクリメントする。
replace オブジェクトキャッシュの既存の値を置き換える。
set オブジェクトキャッシュの値を設定する。
type どのオブジェクトキャッシュが使用されるのか特定する。

cap

使用例

サブコマンド 説明
add 指定のroleに権限を追加する。
list

指定のroleの持つ権限を一覧表示する。

使用例

remove 指定のroleから権限を削除する。

cli

サブコマンド 説明
cmd-dump インストールされているコマンドの一覧をJSON形式で表示する。
completions

タブ補完の文字列を生成する。

オプション

–line=<line>
現在の行が実行される。

–point=<point>
コマンドを開始する場所を、現在のカーソル位置からの相対位置で指定する。

info

CLIの環境に関する様々な情報を表示する。

オプション

[–format=<format>]
指定可能な値: json

param-dump グローバル変数の一覧をJSON形式で表示する。
version WP-CLIのバージョンを表示する。

comment

コメントの管理をするコマンド。

サブコマンド 説明
approve

コメントを承認する。

オプション

<id>
承認するコメントのID

count

ブログ全体または指定した投稿のコメント数を表示する。

オプション

[<post-id>]
コメント数を返す投稿のID

使用例

create

コメントを挿入する。

オプション

–<field>=<value>
新しいコメントの連想配列。wp_insert_comment()参照。

[–porcelain]
新しいコメントのIDを返す。

使用例

delete

コメントを削除する。

オプション

<id> …
削除するコメントのID。(複数指定可)

[–force]
ゴミ箱をスキップ。

使用例

exists

コメントが存在するかどうかを確認する。

オプション

<id>
確認したいコメントのID

使用例

get

1個のコメントを取り出す。

オプション

<id>
取り出すコメント

[–field=<field>]
コメント全体を返す代わりにコメントの値を返す。

[–format=<format>]
指定可能な値: table、json(デフォルトはtable)

使用例

list

コメントの一覧を取得する。

オプション

[–field>=<value>]
WP_Comment_Queryに渡す引数。(複数指定可)

[–field=<field>]
それぞれのコメントついて、指定したフィールドの値を表示する。(複数指定不可)

[–fields=<fields>]
指定したフィールドのみ表示する。デフォルトは、comment_ID, comment_postID, comment_date, comment_approved, comment_author, comment_author_email

使用例

meta

コメントのカスタムフィールドを扱う。

オプション

–format=json
値をJSON形式としてエンコード/デコードする。

使用例

サブコマンド

  • add – メタフィールドを追加する。
    <id>
    オブジェクトのID
    <key>
    新規作成するメタフィールドの名前
    [<value>]
    メタフィールドの値。省略時には標準入力から読み込む。
    [–format=<format>]
    値のシリアル化形式。デフォルトはplaintext。
  • delete – メタフィールドを削除する。
  • get – メタフィールドの値を取得する。
  • update – メタフィールドを更新する。
    <id>
    オブジェクトのID
    <key>
    更新するメタフィールドの名前。
    [<value>]
    新しい値。省略時には標準入力から読み込む。
    [–format=<format>]
    値をシリアル化する形式。デフォルトはplaintext。
spam

スパム処理。

オプション

<id>
スパムとしてマークするコメントのID

使用例

wp comment spam 1337

status

コメントのステータスを取得する。

オプション

<id>
チェックするコメントのID

使用例

trash

コメントをゴミ箱に入れる。

オプション

<id>
ゴミ箱に入れるコメントのID

使用例

anapprove

コメントを承認しない。

オプション

<id>
承認しないコメントのID

使用例

unspam

コメントのスパムとしてのマークを解除する。

オプション

<id>
スパムとしてのマークを解除するコメントのID

使用例

untrash

コメントをゴミ箱から戻す。

オプション

<id>
ゴミ箱から戻すコメントのID

使用例

update

コメントを更新する。(複数指定可)

オプション

<id> …
更新するコメントのID(複数指定可)

–<field>=<value>
更新するフィールド。(複数指定可) wp_update_comment()参照。

使用例

url

コメントのURLを取得する。

オプション

<id> …
URLを取得するコメントのID。(複数指定可)

使用例

core

WordPressnoダウンロード、インストール、更新など。

サブコマンド 説明
config

wp-config.phpファイルを作成する。

オプション

–dbname=<dbname>
データベースの名前を指定する。

–dbuser=<dbuser>
データベースのユーザーを指定する。

[–dbpass=<dbpass>]
データベースのユーザーのパスワードを指定する。

[–dbhost=<dbhost>]
データベースホストを指定する。デフォルトは ‘localhost’

[–dbprefix=<dbprefix>]
データベースのプレフィクスを指定する。デフォルトは ‘wp_’

[–dbcharset=<dbcharset>]
データベースのcharsetを指定する。デフォルトは ‘utf8’

[–dbcollate=<dbcollate>]
データベースの照合順序を指定する。デフォルトは ”

[–locale=<locale>]
WPLANG定数の値を指定する。デフォルトは $wp_local_package の値。

[–extra-php]
指定されたとき、標準入力からPHPの追加コードを読み込む。

[–skip-salts]
指定されたとき、keys と salts が生成されない。ただし、–extra-phpで渡す必要がある。

[–skip-check]
指定されたとき、データベースとのコネクションを確認しない。

使用例

download

WordPressのcoreファイルをダウンロードする。

オプション

[–path=<path>]
WordPressをインストールするpath。

[–locale=<locale>]
ダウンロードしたい言語を選択する。

[–version=<version>]
ダウンロードするバージョンを選択する。

[–force]
ファイルが既に存在していた場合、上書きするかどうかを指定する。

使用例

install

データベースにWordPressのテーブルを作成する。

オプション

–url=<url>
新しいサイトのアドレス。

–title=<site-title>
新しいサイトのタイトル。

–admin_user=<username>
管理者名。

–admin_password=<password>
管理者のパスワード。

–admin_email=<email>
管理者の電子メールアドレス。

is-installed

WordPressのテーブルがインストールされているかどうかを返す。

オプション

[–network]
マルチサイトとしてインストールされているかどうかを確認する。

使用例

multisite-convert

シングルサイトとしてインストールされたものをマルチサイトに変換する。

オプション

[–title=<network-title>]
新しいネットワークのタイトル。

[–base=<url-path>]
それぞれのサイトのURLのpathのベース部分。。デフォルトは ‘/’

[–subdomains]
指定されたとき、サブディレクトリの代わりにサブドメインを使用する。

multiste-install

マルチサイトを始めからインストールする。

オプション

[–url=<url>]
新しいサイトのアドレス。

[–base=<url-path>]
それぞれのサイトのURLのpathのベース部分。デフォルトは ‘/’

[–subdomains]
指定されたとき、サブディレクトリの代わりにサブドメインを使用する。

–title=<site-title>
新サイトのタイトル

–admin_user=<username>
管理者名。

–admin_password=<password>
管理者のパスワード。

–admin_email=<email>
管理者の電子メールアドレス。

update

WordPressをアップデートする。

オプション

[<zip>]
インストールに使用するzipファイルの置き場所を指定する。指定がなければwordpress.orgからダウンロードする。

[–version=<version>]
インストールするバージョンを指定。指定がなければ最新版をインストールする。

[–force]
すでにインストールされているWordPressのバージョンの方が新しくても、指定されたバージョンで上書きする。

[–locale=<locale>]
ダウンロードする言語を指定する。

使用例

update-db WordPressのデータベースをアップデートする。
version

WordPressのバージョンを表示する。

オプション

[–extra]
バージョンに関する詳細な情報を表示する。

db

データベースの基本的な操作。

サブコマンド 説明
cli WordPressの認証情報を使ってmysqlのコンソールを開く。
create wp-config.phpに指定された情報でデータベースを作成する。
drop

データベースを削除する。

オプション

[–yes]
確認メッセージに yes と入力する。

export

データベースから指定されたファイルまたは標準出力にエクスポートする。

オプション

[<file>]
エクスポート先のSQLファイル名。 ‘-‘ を指定すると標準出力に出力する。省略時には ‘{dbname}.sql’ に出力する。

[–field>=<value>]
mysqldumpに渡す追加の変数。

[–tables=<tables>]
エクスポートするテーブル名をカンマで区切って指定する。省略時にはすべてのテーブルをエクスポートする。

使用例

import

データベースに指定されたファイルまたは標準入力からインポートする。

オプション

[<file>]
インポートするSQLファイル名。 ‘-‘ を指定すると標準入力から読み込む。省略時には ‘{dbname}.sql’ を探す。

optimize データベースをオプティマイズする。
query

データベースにクエリーを実行する。

オプション

[<sql>]
SQLクエリー。指定がない場合には標準入力から読み込む。

使用例

repair データベースを修復する。
reset

データベースからすべてのテーブルを削除する。

オプション

[–yes]
確認メッセージに yes と入力する。

tables

データベース上のテーブルを一覧表示する。

オプション

[–scope=<scope>]
all、global、ms_global、blogまたはold_tablesを指定する。デフォルトはall。

使用例

eval

WordPressを起動した後、任意のPHPコードを実行する。

使用例

eval-file

オプション

<file>
実行するPHPファイルのpath。

[<arg> …]
ファイルに渡す引数。複数指定可。$args変数に格納される。

使用例

export

オプション

[–dir=<dirname>]
WXRエクスポートファイルを置くディレクトリへのフルpath。デフォルトはカレントディレクトリ。

[–skip_comments]
コメントをエクスポートしない。

[–max_file_size=<MB>]
エクスポートファイルサイズの上限。

フィルタ

[–start_date=<date>]
YYYY-MM-DDで指定した日付より新しい投稿をエクスポートする。

[–end_date=<date>]
YYYY-MM-DDで指定した日付より古い投稿をエクスポートする。

[–post_type=<post-type>]
指定したpost_typeの投稿のみエクスポートする。

[–post__in=<pid>]
カンマで区切って指定されたIDの投稿すべてをエクスポートする。

[–author=<author>]
指定した著者の投稿のみエクスポートする。ユーザー名またはユーザーIDで指定する。

[–category=<name>]
指定したカテゴリの投稿のみエクスポートする。

[–post_status=<status>]
指定したステータスの投稿のみエクスポートする。

使用例

help

コマンドのヘルプを表示する。

使用例

import

WXRファイルからインポートする。

オプション

<file> …
インポートに使用するWXRファイルを指定する。複数指定可。

–authors=<authors>
著者をどうマッピングするかを指定する。指定可能なオプションは、’create’、’mapping.csv’、および ‘skip’。’create’ が指定されたとき、WXRファイル中にある存在しないユーザーをすべて新規作成する。’mapping.csv’ が指定されると、どのユーザーにマッピングするかをCSVファイルから読み込む。指定したファイルが存在しない場合、編集用にCSVファイルを作成する。CSVファイルはヘッダ行と2つのカラムからなり、”古いユーザー名,新しいユーザー名” のように記述する。’skip’ が指定されると、著者のマッピングを行わない。

[–skip=<data-type>]
指定したデータをインポート対象からはずす。指定可能なオプションは ‘attachment’ および ‘image_resize’ (サムネイルの生成を省略する。)

media

添付ファイルの管理。

サブコマンド 説明
import

ローカルファイルまたはURLから添付ファイルを作成する。

オプション

<file>
インポートするファイル(複数指定可)のpath。使用中のシェルのglob(3)機能を利用可。指定されたファイルがURLとして認識された場合(httpやftp)、取り込み前に一時ファイルにダウンロードする。

–post_id=<post_id>
インポートしたファイルを添付する投稿のID。

–title=<title>
添付のタイトル(投稿のタイトル欄)

–caption=<caption>
添付のキャプション(投稿の抜粋欄)

–alt=<alt_text>
画像のAltテキスト(投稿のmetaデータとして保存)

–desc=<description>
添付投稿の “Description” フィールド(投稿の本文)。

–featured_image
指定されたとき、添付する投稿のアイキャッチ画像に設定する。

使用例

regenerate

サムネイルを再生成する。

オプション

[<attachment-id> …]
サムネイルを再生成する添付ファイルのID(複数指定可)。

[–yes]
確認メッセージにyesと答える。

使用例

メニューの一覧、作成、割り当て、削除。

サブコマンド 説明
create

新しいメニューを作成。

オプション

<menu-name>
メニューの説明文。

[–porcelain]
新しいメニューのIDを出力。

使用例

delete メニューを削除。

オプション

<menu> …
削除するメニューの名前、スラグ、またはID。(複数指定可)

使用例

item

メニュー項目の一覧表示、追加、削除。

使用例

サブコマンド

  • add-custom – カスタムメニュー項目を追加
    <menu>
    メニューの名前、スラグ、またはID。
    <title>
    リンクのタイトル。
    <link>
    リンクのURL。
    [–description=<description>]
    メニュー項目の説明。
    [–attr-title=<attr-title>]
    メニュー項目のタイトル属性。
    [–target=<target>]
    メニュー項目のtarget属性。
    [–classes=<classes>]
    メニュー項目のクラス。
    [–position=<position>]
    メニュー項目の位置。
    [–parent-id=<parent-id>]
    メニュー項目の親メニュー項目を指定。
    [–porcelain]
    新しいメニュー項目のIDのみを表示。

    使用例

  • add-post – 投稿をメニュー項目として追加
    <menu>
    メニューの名前、スラグ、またはID。
    <post-id>
    メニューに追加する投稿のID。
    [–title=<title>]
    リンクのタイトル。
    [–link=<link>]
    リンクのURL。
    [–description=<description>]
    メニュー項目の説明。
    [–attr-title=<attr-title>]
    メニュー項目のタイトル属性。
    [–target=<target>]
    メニュー項目のtarget属性。
    [–classes=<classes>]
    メニュー項目のクラス。
    [–position=<position>]
    メニュー項目の位置。
    [–parent-id=<parent-id>]
    メニュー項目の親メニュー項目を指定。
    [–porcelain]
    新しいメニュー項目のIDのみを表示。

    使用例

  • add-term – タクソノミータームをメニュー項目として追加
    <menu>
    メニューの名前、スラグ、またはID。
    <taxonomy>
    追加するタクソノミー。
    <term-id>
    メニューに追加するタームのID。
    [–title=<title>]
    リンクのタイトル。
    [–link=<link>]
    リンクのURL。
    [–description=<description>]
    メニュー項目の説明。
    [–attr-title=<attr-title>]
    メニュー項目のタイトル属性。
    [–target=<target>]
    メニュー項目のtarget属性。
    [–classes=<classes>]
    メニュー項目のクラス。
    [–position=<position>]
    メニュー項目の位置。
    [–parent-id=<parent-id>]
    メニュー項目の親メニュー項目を指定。
    [–porcelain]
    新しいメニュー項目のIDのみを表示。

    使用例

  • delete – メニューから項目を削除
    <db-id>
    削除するメニュー項目のデータベースID。

    使用例

  • list – メニューの項目を一覧表示
    <menu>
    メニューの名前、スラグ、またはID。
    [–fields=<fields>]
    指定したオブジェクトフィールドのみ出力する。デフォルトではdb_id,type,title,link

    使用例

  • update – メニューの項目を更新
    <db-id>
    メニュー項目のデータベースID。
    [–title=<title>]
    リンクのタイトル。
    [–link=<link>]
    リンクのURL。
    [–description=<description>]
    メニュー項目の説明。
    [–attr-title=<attr-title>]
    メニュー項目のタイトル属性。
    [–target=<target>]
    メニュー項目のtarget属性。
    [–classes=<classes>]
    メニュー項目のクラス。
    [–position=<position>]
    メニュー項目の位置。
    [–parent-id=<parent-id>]
    メニュー項目の親メニュー項目を指定。

    使用例

list

メニューの一覧を取得。

オプション

[–fields=<fields>]
指定したオブジェクトフィールドのみ出力する。デフォルトではdb_id,type,title,link

[–format=<format>]
指定可能な値は、table、csv、json、count、ids。デフォルトはtable。

使用例

location

メニュー位置の設定。

使用例

サブコマンド

  • assign – メニューにロケーションを割り当て
    <menu>
    メニューの名前、スラグ、またはID。
    <location>
    ロケーションのスラグ。

    使用例

  • list – 現在のテーマ内のロケーションを一覧表示
    [–format=<format>]
    指定可能な値は、table、csv、json、count、ids。デフォルトはtable。

    使用例

  • remove – メニューからロケーションを削除
    <menu>
    メニューの名前、スラグ、またはID。
    <location>
    ロケーションのスラグ。

    使用例

network

マルチサイトのネットワークの管理。

サブコマンド 説明
 meta ネットワークカスタムフィールドを扱う。

option

オプションを扱う。

オプション

[–format=jason]
値をJSONとしてエンコード/デコードする。

使用例

サブコマンド 説明
add

オプションを追加。

オプション

<key>
追加するオプションの名前。

[<value>]
追加するオプションの値。省略時には標準入力から読み込む。

[–format=<format>]
値のシリアル化形式。デフォルトはplaintext。

[–autoload=<autoload>]
このオプションが自動的に読み込まれるべきかどうかを指定する。指定可能な値はyes, no。デフォルトはyes。

使用例

delete オプションを削除。
get オプションを取得。
update

オプションを更新。

オプション

<key>
追加するオプションの名前。

[<value>]
追加するオプションの値。省略時には標準入力から読み込む。

[–format=<format>]
値のシリアル化形式。デフォルトはplaintext。

使用例

plugin

プラグインを取り扱う。

サブコマンド 説明
activete

プラグインを有効にする。

オプション

<plugin>
有効にするプラグイン(複数指定可)。

[–network]
指定時、マルチサイトネットワーク全体でプラグインを有効化する。

deactivate

プラグインを無効にする。

オプション

<plugin>
無効にするプラグイン(複数指定可)。

[–all]
指定時、すべてのプラグインが無効化する。

[–network]
指定時、マルチサイトネットワーク全体でプラグインを無効化する。

delete

プラグインのファイルを削除する。

オプション

<plugin>
削除するプラグイン(複数指定可)。

使用例

get

プラグインの情報を取得する。

オプション

<plugin>
情報を取得するプラグイン(複数指定可)。

[–field=<field>]
プラグインの情報すべてではなく、指定したフィールドのみを表示する。

[–format=<format>]
出力する一覧をtableまたはJSONから選択する。デフォルトはtable。

使用例

install

プラグインをインストールする。

オプション

<plugin|zip|url>
インストール取得するプラグインのスラグ、ローカルなzipファイルまたはネットワーク上のURL。

[–version=<version>]
wordpress.orgから指定したバージョンを取得。省略時には安定バージョンを取得する。

[–force]
確認のプロンプトを出さずにインストール済みのプラグインを上書きする。

[–activate]
プラグインをインストールした後すぐに有効化する。

[–activate-network]
プラグインをインストールした後すぐにネットワーク全体で有効化する。

使用例

is-installed

指定されたプラグインがインストール済みかどうかを確認する。

オプション

<plugin>
確認するプラグイン。

使用例

list

プラグインの一覧を表示する。

オプション

[–field=<value>]
フィールドの値によって結果をフィルタする。

[–field=<field>]
それぞれのプラグインの指定したフィールドを表示する。

[–fields=<fields>]
指定したフィールドのみ表示する。デフォルトはname,status,update,version

[–format=<format>]
指定可能な値は、table、csv、json、count。デフォルトはtable。

使用例

path

プラグインのディレクトリへのpathを表示する。

オプション

[<plugin>]
pathを取得したいプラグインを指定。指定がなければプラグインディレクトリへのpathを表示。

[–dir]
指定時、プラグインファイルではなくそのファイルの置かれたディレクトリのpathを表示。

使用例

search

wordpress.orgプラグインリポジトリを検索する。

オプション

<search>
検索する文字列。

[–per-page=<per-page>]
結果を表示する数。デフォルトは10。

[–field=<field>]
それぞれのプラグインの指定したフィールドを表示する。

[–fields<fields>]

[–format=<format>]
指定可能な値は、table、csv、json、count。デフォルトはtable。

使用例

status

指定されたプラグインの状態を表示する。

オプション

[<plugin>]
状態を取得したいプラグインを指定。

toggle

プラグインの有効/無効状態を切り替える。

オプション

<plugin> …
状態を切り替えたいプラグインを指定。複数指定可。

[–network]
指定時、マルチサイト全体の状態を切り替える。

uninstall

プラグインをアンインストールする。

オプション

<plugin> …
アンインストールプラグインを指定。複数指定可。

[–no-delete]
指定時、プラグインのファイルは削除しない。アンインストールの処理のみ走らせる。

使用例

update

プラグインを更新する。

オプション

[<plugin> …]
更新するプラグインを指定。複数指定可。

[–all]
設定時、新しいバージョンが出ているすべてのプラグインを更新する。

[–version=<version>]
設定時、現在どのバージョンがインストールされているかにかかわらず、最新の開発バージョンに更新する。

[–dry-run]
どのプラグインが更新されるのかをプレビューする。

使用例

post

投稿の管理。

サブコマンド 説明
create

投稿を新規作成する。

オプション

[<file>]
<file>から投稿の本文を読み込む。この値が指定されているとき、–post_content引数は無視する。ファイル名として ‘-‘ を渡すと標準入力から投稿本文を読み込む。

[–<field>=<value>]
作成する投稿に関する連想配列。wp_insert_post()参照。

[–edit]
投稿の本文を編集するためにシステムのエディタを開く。本文がファイル、標準出力、または–post_contentで与えられたときには、それをエディタ内に読み込む。

[–porcelain]
新しい投稿のIDのみを出力する。

使用例

delete

IDで指定した投稿を削除する。

オプション

<id> …
削除する投稿のID。複数指定可。

[–force]
ゴミ箱をスキップする。

使用例

edit

投稿の本文を編集する。

オプション

<id> …
編集する投稿のID。複数指定可。

使用例

generate

複数の投稿を生成する。

オプション

[–count=<number>]
生成する投稿の数。デフォルトは100。

[–post_type=<type>]
生成する投稿のタイプ。デフォルトは ‘post’。

[–post_status=<status>]
生成する投稿の状態。デフォルトは ‘publish’。

[–post_author=<login>]
生成する投稿の著者。デフォルトはnone。

[–post_date=<yyyy-mm-dd>]
生成する投稿の日時。デフォルトは現在時刻。

[–post_content]
指定時、投稿の本文を標準入力から読み込む。

[–max_depth=<number>]
階層的な投稿タイプの場合、子の投稿を作成する深さの最大値を指定。デフォルトは1。

使用例

get

IDで指定した投稿の本文を取得する。

オプション

<id>
取得する投稿のID。

[–field=<field>]
投稿全体を返す代わりに、指定したフィールドのみを返す。

[–format=<format>]
指定可能な値はtable、json。デフォルトはtable。

使用例

list

投稿の一覧を取得する。

オプション

[–<field>=<value>]
WP_Queryに渡す引数。複数指定可。

[–field=<field>]
それぞれの投稿の指定したフィールドを表示。

[–fields=<fields>]
指定したフィールドのみ表示する。デフォルトはID, post_tytle, post_name, post_date, post_status。

[–format=<format>]
指定可能な値はtable、csv、json、count、ids。デフォルトはtable。

使用例

meta

投稿のカスタムフィールドを管理する。

オプション

[–format=json]
値をJSONでエンコード/デコードする。

使用例

サブコマンド

  • add – カスタムフィールドを追加
    <id>
    オブジェクトのID。
    <key>
    作成するカスタムフィールド名。
    [<value>]
    カスタムフィールドの値。省略時には標準入力から読み込む。
    [–format=<format>]
    値のシリアル化形式。デフォルトはplaintext。
  • delete – カスタムフィールドを削除
  • get – カスタムフィールドの値を取得
  • update – カスタムフィールドを更新
    <id>
    オブジェクトのID。
    <key>
    作成するカスタムフィールド名。
    [<value>]
    カスタムフィールドの値。省略時には標準入力から読み込む。
    [–format=<format>]
    値のシリアル化形式。デフォルトはplaintext。
update

投稿を更新する。複数更新可。

オプション

<id> …
更新する投稿のID。複数指定可。

–<field>=<value>
更新するフィールド。wp_update_post()参照。

使用例

url

投稿のURLを取得する。

オプション

<id> …
URLを取得する投稿のID。複数指定可。

使用例

rewrite

rewriteルールの管理。

サブコマンド 説明
flush

rewrite ruleをフラッシュする。

オプション

[–hard]
ハード的にフラッシュする。すなわち、データベース内部のrewriteルールと同時に.htaccessのルールも更新する。

list

現在のrewriteルールを表示する。

オプション

[–match=<url>]
指定したURLに合うrewriteルールを表示。

[–source=<source>]
指定したソースのrewriteルールを表示。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

structure

permalink構造を更新する。

オプション

<permastruct>
適用するpermalink構造。

[–category-base=<base>]
カテゴリpermalinkのベース(i.e. ‘/category/’)を指定する。

[–tag-base=<base>]
タグpermalinkのベース(i.e. ‘/tag/’)を指定する。

[–hard]
ハード的にフラッシュする。すなわち、データベース内部のrewriteルールと同時に.htaccessのルールも更新する。

使用例

role

ユーザーの権限グループを管理。

サブコマンド 説明
create

新しい権限グループを作成する。

オプション

<role-key>
権限グループの内部的な名前。

<role-name>
権限グループの表示用の名前。

使用例

delete

既存の権限グループを削除する。

オプション

<role-key>
削除する権限グループの内部名。

使用例

exists

指定された権限グループが存在するか確認する。存在すれば0、存在しなければ1を返す。

オプション

<role-key>
存在を確認する権限グループの内部名。

使用例

list

権限グループの一覧を表示する。

オプション

[–fields=<fields>]
指定したフィールドのみを表示する。デフォルトはname,role。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

reset

デフォルトの権限グループの権限を初期化する。

オプション

[<role-key> …]
初期化する権限グループの内部名。複数指定可。

[–all]
指定時、すべてのデフォルト権限グループを初期化する。

使用例

scaffold

投稿型やタクソノミーなどのためのコードを生成する。

サブコマンド 説明
_s

テーマのひな形コードを生成する。

オプション

<slug>
新しいテーマのスラグ。関数名のプレフィクスとして使用する。

[–activate]
新しくダウンロードしたテーマを有効化する。

[–theme_name=<title>]
style.cssの ‘Theme Name:’ ヘッダに設定する値。

[–author=<full-name>]
style.cssの ‘Author:’ ヘッダに設定する値。

[–author_uri=<uri>]
style.cssの ‘Author URI:’ ヘッダに設定する値。

child-theme

空の子テーマを生成する。

オプション

<slug>
新しい子テーマのスラグ。

–parent_theme=<slug>
style.cssの ‘Template:’ ヘッダに設定する値。

[–theme_name=<title>]
style.cssの ‘Theme Name:’ ヘッダに設定する値。

[–author=<full-name>]
style.cssの ‘Author:’ ヘッダに設定する値。

[–author_uri=<uri>]
style.cssの ‘Author URI:’ ヘッダに設定する値。

[–theme_uri=<uri>]
style.cssの ‘Theme URI:’ ヘッダに設定する値。

[–activate]
新しくダウンロードしたテーマを有効化する。

plugin

pluginのひな形コードを生成する。

オプション

<slug>
プラグインの内部名。

[–plugin_name=<title>]
‘Plugin Name:’ ヘッダに設定する値。

[–skip-tests]
単体テスト用のファイルを生成しない。

[–activate]
新しく作成したプラグインを有効化する。

plugin-tests

PHPUnitを使ったテストに必要なPHPコードを生成する。作成するファイルは次のとおり。

  • phpunit.xml – PHPUnitのためのコンフィグファイル
  • .travis.yml – Travis CIのためのコンフィグファイル
  • tests/bootstrap.php – テストスイートを走らせたときに現在のプラグインを有効化するためのファイル
  • tests/test-sample.php – 実際のテスト内容を含むサンプルファイル

環境変数

tests/bootstrap.php ファイルは WP_TESTS_DIR 環境変数を参照する。

オプション

<slug>
テスト用のファイルを生成するプラグインの内部名。

使用例

post-type

カスタム投稿型を登録するためのPHPコードを生成する。

オプション

<slug>
カスタム投稿型の内部名。

[–label=<label>]
更新メッセージの翻訳に使用するテキスト。

[–textdomain=<textdomain>]
ラベルに使用するtextdomain。

[–theme]
標準出力に出力するかわりに、現在有効化されているテーマのディレクトリにファイルを生成する。–theme=<theme> と指定すると、指定したテーマのディレクトリにファイルを生成する。

[–plugin=<plugin>]
標準出力に出力するかわりに、指定したプラグインのディレクトリにファイルを生成する。

[–raw]
register_post_type()コールのみを生成する。

texonomy

カスタムタクソノミーを登録するためのPHPコードを生成する。

オプション

<slug>
カスタムタクソノミーの内部名。

[–post_types=<post-types>]
タクソノミーを登録する投稿型。

[–label=<label>]
更新メッセージの翻訳に使用するテキスト。

[–textdomain=<textdomain>]
ラベルに使用するtextdomain。

[–theme]
標準出力に出力するかわりに、現在有効化されているテーマのディレクトリにファイルを生成する。–theme=<theme> と指定すると、指定したテーマのディレクトリにファイルを生成する。

[–plugin=<plugin>]
標準出力に出力するかわりに、指定したプラグインのディレクトリにファイルを生成する。

[–raw]
register_taxonomy()コールのみを生成する。

search-replace

データベース中の文字列を検索/置換する。

オプション

<old>
置換前文字列。

<new>
置換後文字列。

[<table> …]
置換を実行するテーブルを指定したもののみに制限する。

[–network]
マルチサイト全体に置換を適用する。

[–skip-columns=<columns>]
カンマ区切りで指定したカラムには置換を適用しない。

[–dry-run]
実際の置換は行わず、レポートを表示するのみ。

[–recurse-objects]
文字列置換を再帰的に行う。

使用例

shell

インタラクティブなPHPコンソール。

wp shellを使えば、WordPress環境の中のPHPの記述をインタラクティブに確認することが可能。つまり、たとえばWordPressのプラグイン内からアクセスするすべての関数、クラス、グローバル変数へのアクセスができる。

オプション

[–basic]
Borisが利用可能であってもフェールセーフモードで起動する。

サイドバーの管理

サブコマンド 説明
list

登録されているサイドバーを一覧表示。

オプション

[–fields=<fields>]
指定されたフィールドのみ出力する。デフォルトはname,id,description。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

site

サイト全体への操作。

サブコマンド 説明
create

マルチサイトにサイトをインストールする。

オプション

–slug=<slug>
新しいサイトへのpath。サブドメイン型の場合にはサブドメイン、サブディレクトリ型の場合にはサブディレクトリ。

–title=<title>
新しいサイトのタイトル。デフォルトはスラグに指定された値。

–email=<email>
管理者ユーザーの電子メールアドレス。ユーザーが存在しなければ作成する。含まれていなければSuper Adminに割り当てる。(?)

–network_id=<network-id>
新しいサイトを作成するネットワーク。デフォルトはカレントネットワーク。(だいたいの場合は1)

–private
指定時、新しいサイトは非公開(インデックス対象としない)とする。

–porcelain
作成できたサイトのIDのみを表示する。

delete

マルチサイトからサイトを削除する。

オプション

[<site-id>]
削除するサイトのID。IDを指定しない場合には、–slug引数で指定する。

[–slug=<slug>]
削除するブログへのpath。サブドメイン型の場合にはサブドメイン、サブディレクトリ型の場合にはサブディレクトリ。

[–yes]
確認メッセージにyesと答える。

[–keep-tables]
具ログを一覧から削除するが、テーブルはdropしない。

empty

サイトの中身を空にする。(投稿、コメント、タグ)

オプション

[–yes]
確認メッセージにyesと答える。

list

マルチサイトにインストールされているサイトの一覧を表示する。

オプション

[–network=<id>]
サイトの属しているネットワーク。

[–field=<field>]
指定したフィールドのみを表示。

[–fields=<fields>]
カンマ区切りで指定したフィールドのみ表示。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

url

サイトのURLを取得する。

オプション

<id> …
URLを取得したいサイトのID。複数指定可。

使用例

super-admin

特権管理者の管理。

サブコマンド 説明
add

特権管理者権限をユーザーに与える。

オプション

<user> …
特権管理者権限を与えるユーザーのID、電子メールアドレス、またはログイン名。

list 特権管理者権限を持つユーザーの一覧を表示する。
remove

特権からスーパー管理者権限を剥奪する。

オプション

<user> …
特権管理者権限を剥奪するユーザーのID、電子メールアドレス、またはログイン名。

term

タームの管理。

サブコマンド 説明
create

タームを作成する。

オプション

<taxonomy>
新しくタームを作成するタクソノミー。

<term>
新しく作成するタームの名前。

[–slug=<slug>]
新しいタームのユニークなスラグ。デフォルトでは名前をサニタイズしたもの。

[–description=<description>]
作成するタームの説明。

[–parent=<term-id>]
作成するタームの親。

[–porcelain]
新しいタームのIDのみを表示する。

使用例

delete

タームを削除する。

オプション

<taxonomy>
タームを削除するタクソノミー。

<term-id> …
削除するタームのID。複数指定可。

使用例

generate

複数のタームを生成する。

オプション

<taxonomy>
タームを作成するタクソノミー。

[–count=<number>]
作成するタームの数。デフォルトでは100。

[–max_depth=<number>]
指定された深さまでの子タームを作成する。デフォルトは1。

使用例

get

タクソノミータームを取得する。

オプション

<taxonomy>
タームを取得するタクソノミー。

[–field=<field>]
指定したフィールドのみ出力する。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

list

タクソノミー中のタームを一覧表示する。

オプション

<taxonomy>
指定したタクソノミーのタームを一覧表示。

[–<field>=<value>]
指定したフィールドでフィルタする。指定可能なフィールドについてはget_terms()参照。

[–field=<field>]
指定したフィールドのみ出力する。単体指定。

[–fields=<fields>]
指定したフィールドのみ出力する。複数指定。デフォルトはタームのすべてのフィールド。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

update

タームを更新する。

オプション

<taxonomy>
タームを更新するタクソノミー。

<term-id>
更新するタームのID。

[–name=<name>]
タームの名前。

[–slug=<slug>]
タームのスラグ。

[–description=<description>]
タームの説明。

[–parent=<term-id>]
親とするタームのID。

使用例

url

タームのURLを取得する。

オプション

<taxonomy>
URLを取得したいタームのタクソノミー。

<term-id> …
URLを取得するするタームのID。複数指定可。

使用例

theme

テーマの管理。

サブコマンド 説明
activate

テーマを有効化する。

オプション

<theme>
有効化するテーマ。

delete

テーマを削除する。

オプション

<theme> …
削除するテーマ。複数指定可。

使用例

disable

マルチサイトの中のテーマを無効化する。

オプション

<theme>
無効化するテーマ。

[–network]
指定時、ネットワークレベルで無効化する。ただし、サイトで個別に有効化していればそのサイトでは有効。

使用例

enable

マルチサイトの中のテーマを有効化する。

オプション

<theme>
有効化するテーマ。

[–network]
指定時、ネットワークレベルで有効化する。

[–activate]
指定時、カレントサイトで指定されたテーマを有効化する。–networkフラグはこの設定と無関係であることに注意。

使用例

get

テーマを取得する。

オプション

<theme>
取得するするテーマ。

[–field=<field>]
指定したフィールドのみ表示する。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

install

テーマをインストールする。

オプション

<theme|zip|url>
インストール取得するテーマのスラグ、ローカルなzipファイルまたはネットワーク上のURL。

[–version=<version>]
wordpress.orgから指定したバージョンを取得。省略時には安定バージョンを取得する。

[–force]
確認のプロンプトを出さずにインストール済みのテーマを上書きする。

[–activate]
テーマをインストールした後すぐに有効化する。

使用例

is-installed

テーマがインストールされているか確認する。

オプション

<theme>
確認するテーマ。

使用例

list

テーマの一覧を取得する。

オプション

[–<field>=<value>]
指定したフィールドと値でフィルタする。

[—field=<field>]
指定したフィールドのみ表示する。単体指定。

[–fields=fields>]
指定したフィールドのみ表示する。複数指定。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

mod

テーマの設定情報を管理する。

サブコマンド

  • get – テーマの設定情報を一覧表示
    [<mod> …]
    表示する設定。複数指定可。
    [–all]
    すべての設定を表示。
    [–format=<format>]
    指定可能な値はtable、csv、json、count。デフォルトはtable。

    使用例

  • remove – テーマの設定情報を削除
    [<mod> …]
    削除する設定。複数指定可。
    [–all]
    すべての設定を削除。

    使用例

  • set – テーマの設定情報を設定
    <mod>
    新しく設定、または値を更新する設定の名前。
    <value>
    設定する値。

    使用例

path

テーマまたはテーマディレクトリへのpathを取得する。

オプション

[<theme>]
pathを取得するテーマ。style.cssファイルをpathに含む。省略時には、テーマディレクトリへのpathを表示する。

[–dir]
指定時に、指定したテーマのstyle.cssのかわりに、そのファイルの置かれているディレクトリを表示する。

使用例

search

wordpress.orgテーマリポジトリを検索する。

オプション

<search>
検索語。

[–per-page=<per-page>]
表示する結果の数。デフォルトでは10。

[–field=<field>]
指定したフィールドのみ表示。単体指定。

[–fields=<fields>]
指定したフィールドのみ表示。複数指定。デフォルトではname,slug,author,rating。指定可能な値は次のとおり。

  • name – テーマの名前
  • slug – テーマのスラグ
  • version – 現在のバージョン番号
  • author – 作者名
  • preview_url – プレビューのURL
  • screenshot_url – スクリーンショットのURL
  • rating – テーマの評価
  • homepage – テーマ作者のホームページ
  • description – テーマの説明

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

status

テーマの状態を表示する。

オプション

[<theme>]
状態を表示したいテーマ。指定がなければすべてのテーマの状態を表示。

update

テーマを更新する。

オプション

[<theme> …]
更新するテーマ。複数指定可。

[–all]
新しいヴァージョンが出ているすべてのテーマを更新。

[–version=<version>]
現在インストールされているテーマのバージョンにかかわらず、最新の開発バージョンにアップデート。

[–dry-run]
どのテーマがアップデートされるのかをプレビュー。

使用例

transient

transientを管理。

サブコマンド 説明
delete transientの値を削除する。
delete-all すべてのtransientを削除する。
delete-expired 期限切れとなったすべてのtransientを削除する。
get transient値を取得する。
set transient値を設定する。<expiration>には期限を秒数で指定する。
type transient APIがオブジェクトキャッシュまたはオプションテーブルのいずれを使っているかを確認する。

user

ユーザーを管理する。

サブコマンド 説明
add-cap

ユーザーに権限を追加する。

オプション

<user>
ユーザーID、ユーザーの電子メールアドレス、またはログインユーザー名。

<cap>
追加する権限。

使用例

add-role

ユーザーに権限グループを追加する。

オプション

<user>
ユーザーID、ユーザーの電子メールアドレス、またはログインユーザー名。

<role>
追加する権限グループ。

使用例

create ユーザーを新規追加する。

オプション

<user-login>
新規追加するユーザーのログイン名。

<user-email>
新規追加するユーザーの電子メールアドレス。

[–role=<role>]
新規追加するユーザーの権限グループ。デフォルトはrole。

[–user_pass=<password>]
ユーザーのパスワード。デフォルトはランダムに生成された値。

[–user_registered=<yyyy-mm-dd>]
ユーザー登録の日時。デフォルトは現在時刻。

[–display_name=<name>]
ユーザーの表示用の名前。

[–send-email]
指定時、ユーザーにアカウント情報を記したメールを送信。

[–porcelain]
新規追加されるユーザーのIDのみを出力。

使用例

delete

ユーザーを削除する。複数指定可。

オプション

<user>
削除するユーザーのID、電子メールアドレス、またはログイン名。

[–network]
マルチサイトにおいて、ネットワーク全体からユーザーを削除。

[–reassign=<user-id>]
投稿を割り当てるユーザーID。

[–yes]
すべての確認プロンプトにyesと答える。

使用例

generate

複数ユーザーをまとめて生成する。

オプション

[–count=<number>]
何人分のユーザーを生成するか。デフォルトでは100。

[–role=<role>]
生成するユーザーの権限グループ。デフォルトは、WordPressでデフォルトとしている権限グループ。

get

ひとりのユーザー情報を取得する。

オプション

<user>
ユーザーID、ユーザーの電子メールアドレス、またはログインユーザー名。

[–field=<field>]
指定したフィールドのみ表示する。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

import-csv

CSVファイルからユーザーをインポートする。

オプション

<file>
ユーザーをインポートするCSVファイル。

[–send-email]
指定時、新規登録されたユーザーにアカウント情報を電子メールで送信。

使用例

users.csvのサンプル

list

ユーザーを一覧表示する。

オプション

[–role=<role>]
指定の権限グループのユーザーのみ表示。

[–<field>=<value>]
指定したフィールドの値により結果をフィルタする。指定可能なフィールドについてはget_users()参照。

[–field=<field>]
指定したフィールドの値のみ表示。単体指定。

[–fields=<fields>]
指定したフィールドの値のみ表示。複数指定。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

list-caps

ユーザーのすべての権限を表示する。

オプション

<user>
表示するユーザーのID、電子メールアドレス、またはログイン名。

使用例

meta

ユーザーのカスタムフィールドを管理する。

オプション

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

サブコマンド

  • add – カスタムフィールドを追加
    <user>
    カスタムフィールドを追加するユーザーのID、電子メールアドレス、またはログイン名。
    <key>
    カスタムフィールドのキー。
    <value>
    カスタムフィールドの値。
  • delete – カスタムフィールドを削除
    <user>
    カスタムフィールドを削除するユーザーのID、電子メールアドレス、またはログイン名。
    <key>
    カスタムフィールドのキー。
  • get – カスタムフィールドの値を表示
    <user>
    カスタムフィールドを取得するユーザーのID、電子メールアドレス、またはログイン名。
    <key>
    カスタムフィールドのキー。
    [–format=<format>]
    指定可能な値はtable、csv、json、count。デフォルトはtable。
  • update – カスタムフィールドの値を更新
    <user>
    カスタムフィールドを更新するユーザーのID、電子メールアドレス、またはログイン名。
    <key>
    カスタムフィールドのキー。
    <value>
    カスタムフィールドの値。
remove-cap

ユーザーの権限を削除する。

オプション

<user>
権限を削除するユーザーのID、電子メールアドレス、またはログイン名。

<cap>
削除する権限。

使用例

remove-role

ユーザーの権限グループを削除する。

オプション

<user>
権限グループを削除するユーザーのID、電子メールアドレス、またはログイン名。

[<role>]
削除する権限グループ。

使用例

set-role

特定のブログでのユーザーの権限グループを設定する。

オプション

<user>
権限グループを設定するユーザーのID、電子メールアドレス、またはログイン名。

[<role>]
ユーザーに割り当てる権限グループ。省略時にはデフォルトの権限グループを割り当て。

使用例

update

ユーザー情報を更新する。

オプション

<user> …
情報を更新するユーザーのID、電子メールアドレス、またはログイン名。

–<field>=<value>
更新するフィールド。複数指定可。指定可能なフィールドについては、wp_update_user()参照。

使用例

widget

ウィジェットを管理。

使用例

サブコマンド 説明
add

サイドバーにウィジェットを追加する。

オプション

<name>
ウィジェット名。

<sidebar-id>
関連付けるサイドバーのID。

[<position>]
サイドバー上の位置。デフォルトはlast。

[–<field>=<value>]
追加するウィジェットのオプションと設定値。複数指定可。

使用例

deactivate

有効化されているサイドバーからウィジェットを無効化する。

オプション

<widget-id> …
ウィジェットのユニークID。複数指定可。

使用例

delete

サイドバーからウィジェットを削除する。

オプション

<widget-id> …
ウィジェットのユニークID。複数指定可。

使用例

list

サイドバーに関連付けられているウィジェットを一覧表示する。

オプション

<sidebar-id>
一覧表示したいサイドバーのID。

[–fields=<fields>]
指定したフィールドのみ表示する。デフォルトはname, id, description。

[–format=<format>]
指定可能な値はtable、csv、json、count。デフォルトはtable。

使用例

move

サイドバー上のウィジェットの位置を移動する。

オプション

<widget-id>
ウィジェットのユニークID。

[–position=<position>]
新しい位置を割り当て。

[–sidebar-id=<sidebar-id>]
新しいサイドバーに割り当て。

使用例

update

指定したウィジェットのオプションを更新する。

オプション

<widget-id>
ウィジェットのユニークID。

[–<field>=<value>]
更新するウィジェットのオプションと設定値。複数指定可。

使用例