拡張コマンドダウンロード - 拡張コマンドソースコードダウンロード

wp-cli/拡張コマンド

インストール、アクティベーション、アップデートなどのプラグインとテーマを管理します。

クイックリンク: | の使用インストール |貢献する |サポート

使用する

このパッケージは次のコマンドを実装します。

wpプラグイン

インストール、アクティベーション、アップデートなどのプラグインを管理します。

 wp plugin

プラグインの詳細については、WordPress プラグインハンドブック開発者リソースを参照してください。

例

 # Activate plugin
$ wp plugin activate hello
Plugin 'hello' activated.
Success: Activated 1 of 1 plugins.

# Deactivate plugin
$ wp plugin deactivate hello
Plugin 'hello' deactivated.
Success: Deactivated 1 of 1 plugins.

# Delete plugin
$ wp plugin delete hello
Deleted 'hello' plugin.
Success: Deleted 1 of 1 plugins.

# Install the latest version from wordpress.org and activate
$ wp plugin install bbpress --activate
Installing bbPress (2.5.9)
Downloading install package from https://downloads.wordpress.org/plugin/bbpress.2.5.9.zip...
Using cached file '/home/vagrant/.wp-cli/cache/plugin/bbpress-2.5.9.zip'...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating 'bbpress'...
Plugin 'bbpress' activated.
Success: Installed 1 of 1 plugins.

WPプラグインを有効化

1 つ以上のプラグインを有効にします。

 wp plugin activate [...] [--all] [--exclude=] [--network]

オプション

 [...]
	One or more plugins to activate.

[--all]
	If set, all plugins will be activated.

[--exclude=]
	Comma separated list of plugin slugs to be excluded from activation.

[--network]
	If set, the plugin will be activated for the entire multisite network.

例

 # Activate plugin
$ wp plugin activate hello
Plugin 'hello' activated.
Success: Activated 1 of 1 plugins.

# Activate plugin in entire multisite network
$ wp plugin activate hello --network
Plugin 'hello' network activated.
Success: Network activated 1 of 1 plugins.

# Activate plugins that were recently active.
$ wp plugin activate $(wp plugin list --recently-active --field=name)
Plugin 'bbpress' activated.
Plugin 'buddypress' activated.
Success: Activated 2 of 2 plugins.

# Activate plugins that were recently active on a multisite.
$ wp plugin activate $(wp plugin list --recently-active --field=name) --network
Plugin 'bbpress' network activated.
Plugin 'buddypress' network activated.
Success: Activated 2 of 2 plugins.

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

1 つ以上のプラグインを非アクティブ化します。

 wp plugin deactivate [...] [--uninstall] [--all] [--exclude=] [--network]

オプション

 [...]
	One or more plugins to deactivate.

[--uninstall]
	Uninstall the plugin after deactivation.

[--all]
	If set, all plugins will be deactivated.

[--exclude=]
	Comma separated list of plugin slugs that should be excluded from deactivation.

[--network]
	If set, the plugin will be deactivated for the entire multisite network.

例

 # Deactivate plugin
$ wp plugin deactivate hello
Plugin 'hello' deactivated.
Success: Deactivated 1 of 1 plugins.

# Deactivate all plugins with exclusion
$ wp plugin deactivate --all --exclude=hello,wordpress-seo
Plugin 'contact-form-7' deactivated.
Plugin 'ninja-forms' deactivated.
Success: Deactivated 2 of 2 plugins.

wpプラグインの削除

非アクティブ化またはアンインストールせずにプラグインファイルを削除します。

 wp plugin delete [...] [--all] [--exclude=]

オプション

 [...]
	One or more plugins to delete.

[--all]
	If set, all plugins will be deleted.

[--exclude=]
	Comma separated list of plugin slugs to be excluded from deletion.

例

 # Delete plugin
$ wp plugin delete hello
Deleted 'hello' plugin.
Success: Deleted 1 of 1 plugins.

# Delete inactive plugins
$ wp plugin delete $(wp plugin list --status=inactive --field=name)
Deleted 'tinymce-templates' plugin.
Success: Deleted 1 of 1 plugins.

# Delete all plugins excluding specified ones
$ wp plugin delete --all --exclude=hello-dolly,jetpack
Deleted 'akismet' plugin.
Deleted 'tinymce-templates' plugin.
Success: Deleted 2 of 2 plugins.

wpプラグインの入手

インストールされているプラグインに関する詳細を取得します。

 wp plugin get  [--field=] [--fields=] [--format=]

オプション

 
	The plugin to get.

[--field=]
	Instead of returning the whole plugin, returns the value of a single field.

[--fields=]
	Limit the output to specific fields. Defaults to all fields.

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - yaml
	---

利用可能なフィールド

これらのフィールドは、プラグインのデフォルトで表示されます。

名前
タイトル
著者
バージョン
説明
状態

これらのフィールドはオプションで使用できます。

要求_wp
必要な_php
プラグインが必要

例

 # Get plugin details.
$ wp plugin get bbpress --format=json
{"name":"bbpress","title":"bbPress","author":"The bbPress Contributors","version":"2.6.9","description":"bbPress is forum software with a twist from the creators of WordPress.","status":"active"}

wpプラグインのインストール

1 つ以上のプラグインをインストールします。

 wp plugin install ... [--version=] [--force] [--activate] [--activate-network] [--insecure]

オプション

 ...
	One or more plugins to install. Accepts a plugin slug, the path to a local zip file, or a URL to a remote zip file.

[--version=]
	If set, get that particular version from wordpress.org, instead of the
	stable version.

[--force]
	If set, the command will overwrite any installed version of the plugin, without prompting
	for confirmation.

[--activate]
	If set, the plugin will be activated immediately after install.

[--activate-network]
	If set, the plugin will be network activated immediately after install

[--insecure]
	Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

例

 # Install the latest version from wordpress.org and activate
$ wp plugin install bbpress --activate
Installing bbPress (2.5.9)
Downloading install package from https://downloads.wordpress.org/plugin/bbpress.2.5.9.zip...
Using cached file '/home/vagrant/.wp-cli/cache/plugin/bbpress-2.5.9.zip'...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating 'bbpress'...
Plugin 'bbpress' activated.
Success: Installed 1 of 1 plugins.

# Install the development version from wordpress.org
$ wp plugin install bbpress --version=dev
Installing bbPress (Development Version)
Downloading install package from https://downloads.wordpress.org/plugin/bbpress.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Success: Installed 1 of 1 plugins.

# Install from a local zip file
$ wp plugin install ../my-plugin.zip
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Success: Installed 1 of 1 plugins.

# Install from a remote zip file
$ wp plugin install http://s3.amazonaws.com/bucketname/my-plugin.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef
Downloading install package from http://s3.amazonaws.com/bucketname/my-plugin.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Success: Installed 1 of 1 plugins.

# Update from a remote zip file
$ wp plugin install https://github.com/envato/wp-envato-market/archive/master.zip --force
Downloading install package from https://github.com/envato/wp-envato-market/archive/master.zip
Unpacking the package...
Installing the plugin...
Renamed Github-based project from 'wp-envato-market-master' to 'wp-envato-market'.
Plugin updated successfully
Success: Installed 1 of 1 plugins.

# Forcefully re-install all installed plugins
$ wp plugin install $(wp plugin list --field=name) --force
Installing Akismet (3.1.11)
Downloading install package from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip...
Unpacking the package...
Installing the plugin...
Removing the old version of the plugin...
Plugin updated successfully
Success: Installed 1 of 1 plugins.

wpプラグインがインストールされています

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

 wp plugin is-installed

インストールされている場合は終了コード 0、アンインストールされている場合は 1 を返します。

オプション

 
	The plugin to check.

例

 # Check whether plugin is installed; exit status 0 if installed, otherwise 1
$ wp plugin is-installed hello
$ echo $?
1

WPプラグインリスト

プラグインのリストを取得します。

 wp plugin list [--=] [--field=] [--fields=] [--format=] [--status=] [--skip-update-check] [--recently-active]

サイトにインストールされているプラグインのリストを、有効化ステータス、利用可能なアップデートの有無などとともに表示します。

--status=dropin使用して、インストールされているドロップイン (例: object-cache.php ) をリストします。

オプション

 [--=]
	Filter results based on the value of a field.

[--field=]
	Prints the value of a single field for each plugin.

[--fields=]
	Limit the output to specific object fields.

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - count
	  - json
	  - yaml
	---

[--status=]
	Filter the output by plugin status.
	---
	options:
	  - active
	  - active-network
	  - dropin
	  - inactive
	  - must-use
	---

[--skip-update-check]
	If set, the plugin update check will be skipped.

[--recently-active]
	If set, only recently active plugins will be shown and the status filter will be ignored.

利用可能なフィールド

これらのフィールドは、プラグインごとにデフォルトで表示されます。

名前
状態
アップデート
バージョン
アップデートバージョン
auto_update

これらのフィールドはオプションで使用できます。

アップデートパッケージ
更新ID
タイトル
説明
ファイル
著者
テスト済み_まで
wporg_status
wporg_last_updated

例

 # List active plugins on the site.
$ wp plugin list --status=active --format=json
[{"name":"dynamic-hostname","status":"active","update":"none","version":"0.4.2","update_version":"","auto_update":"off"},{"name":"tinymce-templates","status":"active","update":"none","version":"4.8.1","update_version":"","auto_update":"off"},{"name":"wp-multibyte-patch","status":"active","update":"none","version":"2.9","update_version":"","auto_update":"off"},{"name":"wp-total-hacks","status":"active","update":"none","version":"4.7.2","update_version":"","auto_update":"off"}]

# List plugins on each site in a network.
$ wp site list --field=url | xargs -I % wp plugin list --url=%
+---------+----------------+-----------+---------+-----------------+------------+
| name    | status         | update    | version | update_version | auto_update |
+---------+----------------+-----------+---------+----------------+-------------+
| akismet | active-network | none      | 5.3.1   |                | on          |
| hello   | inactive       | available | 1.6     | 1.7.2          | off         |
+---------+----------------+-----------+---------+----------------+-------------+
+---------+----------------+-----------+---------+----------------+-------------+
| name    | status         | update    | version | update_version | auto_update |
+---------+----------------+-----------+---------+----------------+-------------+
| akismet | active-network | none      | 5.3.1   |                | on          |
| hello   | inactive       | available | 1.6     | 1.7.2          | off         |
+---------+----------------+-----------+---------+----------------+-------------+

# Check whether plugins are still active on WordPress.org
$ wp plugin list --fields=name,wporg_status,wporg_last_updated
+--------------------+--------------+--------------------+
| name               | wporg_status | wporg_last_updated |
+--------------------+--------------+--------------------+
| akismet            | active       | 2023-12-11         |
| user-switching     | active       | 2023-11-17         |
| wordpress-importer | active       | 2023-04-28         |
| local              |              |                    |
+--------------------+--------------+--------------------+

# List recently active plugins on the site.
$ wp plugin list --recently-active --field=name --format=json
["akismet","bbpress","buddypress"]

WPプラグインのパス

プラグインまたはプラグインディレクトリへのパスを取得します。

 wp plugin path [] [--dir]

オプション

 []
	The plugin to get the path to. If not set, will return the path to the
	plugins directory.

[--dir]
	If set, get the path to the closest parent directory, instead of the
	plugin file.

例

 $ cd $(wp plugin path) && pwd
/var/www/wordpress/wp-content/plugins

WPプラグイン検索

WordPress.org プラグインディレクトリを検索します。

 wp plugin search  [--page=] [--per-page=] [--field=] [--fields=] [--format=]

指定された検索クエリに一致する WordPress.org プラグインディレクトリ内のプラグインを表示します。

オプション

 
	The string to search for.

[--page=]
	Optional page to display.
	---
	default: 1
	---

[--per-page=]
	Optional number of results to display.
	---
	default: 10
	---

[--field=]
	Prints the value of a single field for each plugin.

[--fields=]
	Ask for specific fields from the API. Defaults to name,slug,author_profile,rating. Acceptable values:

**name**: Plugin Name
**slug**: Plugin Slug
**version**: Current Version Number
**author**: Plugin Author
**author_profile**: Plugin Author Profile
**contributors**: Plugin Contributors
**requires**: Plugin Minimum Requirements
**tested**: Plugin Tested Up To
**compatibility**: Plugin Compatible With
**rating**: Plugin Rating in Percent and Total Number
**ratings**: Plugin Ratings for each star (1-5)
**num_ratings**: Number of Plugin Ratings
**homepage**: Plugin Author's Homepage
**description**: Plugin's Description
**short_description**: Plugin's Short Description
**sections**: Plugin Readme Sections: description, installation, FAQ, screenshots, other notes, and changelog
**downloaded**: Plugin Download Count
**last_updated**: Plugin's Last Update
**added**: Plugin's Date Added to wordpress.org Repository
**tags**: Plugin's Tags
**versions**: Plugin's Available Versions with D/L Link
**donate_link**: Plugin's Donation Link
**banners**: Plugin's Banner Image Link
**icons**: Plugin's Icon Image Link
**active_installs**: Plugin's Number of Active Installs
**contributors**: Plugin's List of Contributors
**url**: Plugin's URL on wordpress.org

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - count
	  - json
	  - yaml
	---

例

 $ wp plugin search dsgnwrks --per-page=20 --format=json
Success: Showing 3 of 3 plugins.
[{"name":"DsgnWrks Instagram Importer Debug","slug":"dsgnwrks-instagram-importer-debug","rating":0},{"name":"DsgnWrks Instagram Importer","slug":"dsgnwrks-instagram-importer","rating":84},{"name":"DsgnWrks Twitter Importer","slug":"dsgnwrks-twitter-importer","rating":80}]

$ wp plugin search dsgnwrks --fields=name,version,slug,rating,num_ratings
Success: Showing 3 of 3 plugins.
+-----------------------------------+---------+-----------------------------------+--------+-------------+
| name                              | version | slug                              | rating | num_ratings |
+-----------------------------------+---------+-----------------------------------+--------+-------------+
| DsgnWrks Instagram Importer Debug | 0.1.6   | dsgnwrks-instagram-importer-debug | 0      | 0           |
| DsgnWrks Instagram Importer       | 1.3.7   | dsgnwrks-instagram-importer       | 84     | 23          |
| DsgnWrks Twitter Importer         | 1.1.1   | dsgnwrks-twitter-importer         | 80     | 1           |
+-----------------------------------+---------+-----------------------------------+--------+-------------+

wpプラグインのステータス

1 つまたはすべてのプラグインのステータスを表示します。

 wp plugin status []

オプション

 []
	A particular plugin to show the status for.

例

 # Displays status of all plugins
$ wp plugin status
5 installed plugins:
  I akismet                3.1.11
  I easy-digital-downloads 2.5.16
  A theme-check            20160523.1
  I wen-logo-slider        2.0.3
  M ns-pack                1.0.0
Legend: I = Inactive, A = Active, M = Must Use

# Displays status of a plugin
$ wp plugin status theme-check
Plugin theme-check details:
    Name: Theme Check
    Status: Active
    Version: 20160523.1
    Author: Otto42, pross
    Description: A simple and easy way to test your theme for all the latest WordPress standards and practices. A great theme development tool!

WPプラグインの切り替え

プラグインの有効化状態を切り替えます。

 wp plugin toggle ... [--network]

プラグインがアクティブな場合は、非アクティブ化されます。プラグインが非アクティブな場合は、アクティブ化されます。

オプション

 ...
	One or more plugins to toggle.

[--network]
	If set, the plugin will be toggled for the entire multisite network.

例

 # Akismet is currently activated
$ wp plugin toggle akismet
Plugin 'akismet' deactivated.
Success: Toggled 1 of 1 plugins.

# Akismet is currently deactivated
$ wp plugin toggle akismet
Plugin 'akismet' activated.
Success: Toggled 1 of 1 plugins.

wpプラグインのアンインストール

1 つ以上のプラグインをアンインストールします。

 wp plugin uninstall [...] [--deactivate] [--skip-delete] [--all] [--exclude=]

オプション

 [...]
	One or more plugins to uninstall.

[--deactivate]
	Deactivate the plugin before uninstalling. Default behavior is to warn and skip if the plugin is active.

[--skip-delete]
	If set, the plugin files will not be deleted. Only the uninstall procedure
	will be run.

[--all]
	If set, all plugins will be uninstalled.

[--exclude=]
	Comma separated list of plugin slugs to be excluded from uninstall.

例

 $ wp plugin uninstall hello
Uninstalled and deleted 'hello' plugin.
Success: Uninstalled 1 of 1 plugins.

# Uninstall all plugins excluding specified ones
$ wp plugin uninstall --all --exclude=hello-dolly,jetpack
Uninstalled and deleted 'akismet' plugin.
Uninstalled and deleted 'tinymce-templates' plugin.
Success: Uninstalled 2 of 2 plugins.

wpプラグインのアップデート

1 つ以上のプラグインを更新します。

 wp plugin update [...] [--all] [--exclude=] [--minor] [--patch] [--format=] [--version=] [--dry-run] [--insecure]

オプション

 [...]
	One or more plugins to update.

[--all]
	If set, all plugins that have updates will be updated.

[--exclude=]
	Comma separated list of plugin names that should be excluded from updating.

[--minor]
	Only perform updates for minor releases (e.g. from 1.3 to 1.4 instead of 2.0)

[--patch]
	Only perform updates for patch releases (e.g. from 1.3 to 1.3.3 instead of 1.4)

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - summary
	---

[--version=]
	If set, the plugin will be updated to the specified version.

[--dry-run]
	Preview which plugins would be updated.

[--insecure]
	Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

例

 $ wp plugin update bbpress --version=dev
Installing bbPress (Development Version)
Downloading install package from https://downloads.wordpress.org/plugin/bbpress.zip...
Unpacking the package...
Installing the plugin...
Removing the old version of the plugin...
Plugin updated successfully.
Success: Updated 1 of 2 plugins.

$ wp plugin update --all
Enabling Maintenance mode...
Downloading update from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the plugin...
Plugin updated successfully.
Downloading update from https://downloads.wordpress.org/plugin/nginx-champuru.3.2.0.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the plugin...
Plugin updated successfully.
Disabling Maintenance mode...
+------------------------+-------------+-------------+---------+
| name                   | old_version | new_version | status  |
+------------------------+-------------+-------------+---------+
| akismet                | 3.1.3       | 3.1.11      | Updated |
| nginx-cache-controller | 3.1.1       | 3.2.0       | Updated |
+------------------------+-------------+-------------+---------+
Success: Updated 2 of 2 plugins.

$ wp plugin update --all --exclude=akismet
Enabling Maintenance mode...
Downloading update from https://downloads.wordpress.org/plugin/nginx-champuru.3.2.0.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the plugin...
Plugin updated successfully.
Disabling Maintenance mode...
+------------------------+-------------+-------------+---------+
| name                   | old_version | new_version | status  |
+------------------------+-------------+-------------+---------+
| nginx-cache-controller | 3.1.1       | 3.2.0       | Updated |
+------------------------+-------------+-------------+---------+

WPテーマ

インストール、アクティベーション、アップデートなどのテーマを管理します。

 wp theme

テーマの詳細については、WordPress テーマハンドブックの開発者リソースを参照してください。

例

 # Install the latest version of a theme from wordpress.org and activate
$ wp theme install twentysixteen --activate
Installing Twenty Sixteen (1.2)
Downloading install package from http://downloads.wordpress.org/theme/twentysixteen.1.2.zip...
Unpacking the package...
Installing the theme...
Theme installed successfully.
Activating 'twentysixteen'...
Success: Switched to 'Twenty Sixteen' theme.
Success: Installed 1 of 1 themes.

# Get details of an installed theme
$ wp theme get twentysixteen --fields=name,title,version
+---------+----------------+
| Field   | Value          |
+---------+----------------+
| name    | Twenty Sixteen |
| title   | Twenty Sixteen |
| version | 1.2            |
+---------+----------------+

# Get status of theme
$ wp theme status twentysixteen
Theme twentysixteen details:
     Name: Twenty Sixteen
     Status: Active
     Version: 1.2
     Author: the WordPress team

WPテーマを有効にする

テーマをアクティブ化します。

 wp theme activate

オプション

 
	The theme to activate.

例

 $ wp theme activate twentysixteen
Success: Switched to 'Twenty Sixteen' theme.

WPテーマの削除

1 つ以上のテーマを削除します。

 wp theme delete [...] [--all] [--force]

ファイルシステムからテーマを削除します。

オプション

 [...]
	One or more themes to delete.

[--all]
	If set, all themes will be deleted except active theme.

[--force]
	To delete active theme use this.

例

 $ wp theme delete twentytwelve
Deleted 'twentytwelve' theme.
Success: Deleted 1 of 1 themes.

WPテーマを無効にする

WordPress マルチサイトインストールでテーマを無効にします。

 wp theme disable  [--network]

WordPress マルチサイトインストールのサイトのダッシュボードからテーマをアクティブ化できる機能を削除します。

オプション

 
	The theme to disable.

[--network]
	If set, the theme is disabled on the network level. Note that
	individual sites may still have this theme enabled if it was
	enabled for them independently.

例

 # Disable theme
$ wp theme disable twentysixteen
Success: Disabled the 'Twenty Sixteen' theme.

# Disable theme in network level
$ wp theme disable twentysixteen --network
Success: Network disabled the 'Twenty Sixteen' theme.

WPテーマを有効にする

WordPress マルチサイトインストールでテーマを有効にします。

 wp theme enable  [--network] [--activate]

WordPress マルチサイトインストール上のサイトのダッシュボードからテーマをアクティブ化できるようにします。

オプション

 
	The theme to enable.

[--network]
	If set, the theme is enabled for the entire network

[--activate]
	If set, the theme is activated for the current site. Note that
	the "network" flag has no influence on this.

例

 # Enable theme
$ wp theme enable twentysixteen
Success: Enabled the 'Twenty Sixteen' theme.

# Network enable theme
$ wp theme enable twentysixteen --network
Success: Network enabled the 'Twenty Sixteen' theme.

# Network enable and activate theme for current site
$ wp theme enable twentysixteen --activate
Success: Enabled the 'Twenty Sixteen' theme.
Success: Switched to 'Twenty Sixteen' theme.

WPテーマを入手

テーマに関する詳細を取得します。

 wp theme get  [--field=] [--fields=] [--format=]

オプション

 
	The theme to get.

[--field=]
	Instead of returning the whole theme, returns the value of a single field.

[--fields=]
	Limit the output to specific fields. Defaults to all fields.

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - yaml
	---

例

 $ wp theme get twentysixteen --fields=name,title,version
+---------+----------------+
| Field   | Value          |
+---------+----------------+
| name    | Twenty Sixteen |
| title   | Twenty Sixteen |
| version | 1.2            |
+---------+----------------+

WPテーマのインストール

1 つ以上のテーマをインストールします。

 wp theme install ... [--version=] [--force] [--activate] [--insecure]

オプション

 ...
	One or more themes to install. Accepts a theme slug, the path to a local zip file, or a URL to a remote zip file.

[--version=]
	If set, get that particular version from wordpress.org, instead of the
	stable version.

[--force]
	If set, the command will overwrite any installed version of the theme, without prompting
	for confirmation.

[--activate]
	If set, the theme will be activated immediately after install.

[--insecure]
	Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

例

 # Install the latest version from wordpress.org and activate
$ wp theme install twentysixteen --activate
Installing Twenty Sixteen (1.2)
Downloading install package from http://downloads.wordpress.org/theme/twentysixteen.1.2.zip...
Unpacking the package...
Installing the theme...
Theme installed successfully.
Activating 'twentysixteen'...
Success: Switched to 'Twenty Sixteen' theme.
Success: Installed 1 of 1 themes.

# Install from a local zip file
$ wp theme install ../my-theme.zip

# Install from a remote zip file
$ wp theme install http://s3.amazonaws.com/bucketname/my-theme.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef

WPテーマがインストールされています

指定されたテーマがインストールされているかどうかを確認します。

 wp theme is-installed

インストールされている場合は終了コード 0、アンインストールされている場合は 1 を返します。

オプション

 
	The theme to check.

例

 # Check whether theme is installed; exit status 0 if installed, otherwise 1
$ wp theme is-installed hello
$ echo $?
1

WPテーマリスト

テーマのリストを取得します。

 wp theme list [--=] [--field=] [--fields=] [--format=] [--status=] [--skip-update-check]

オプション

 [--=]
	Filter results based on the value of a field.

[--field=]
	Prints the value of a single field for each theme.

[--fields=]
	Limit the output to specific object fields.

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - count
	  - yaml
	---

[--status=]
	Filter the output by theme status.
	---
	options:
	  - active
	  - parent
	  - inactive
	---

[--skip-update-check]
	If set, the theme update check will be skipped.

利用可能なフィールド

これらのフィールドは、テーマごとにデフォルトで表示されます。

名前
状態
アップデート
バージョン
アップデートバージョン
auto_update

これらのフィールドはオプションで使用できます。

更新パッケージ
更新ID
タイトル
説明

例

 # List inactive themes.
$ wp theme list --status=inactive --format=csv
name,status,update,version,update_version,auto_update
twentyfourteen,inactive,none,3.8,,off
twentysixteen,inactive,available,3.0,3.1,off

WPテーマMOD

テーマ MOD を設定、取得、削除します。

 wp theme mod

例

 # Set the 'background_color' theme mod to '000000'.
$ wp theme mod set background_color 000000
Success: Theme mod background_color set to 000000.

# Get single theme mod in JSON format.
$ wp theme mod get background_color --format=json
[{"key":"background_color","value":"dd3333"}]

# Remove all theme mods.
$ wp theme mod remove --all
Success: Theme mods removed.

WPテーマMODを入手

1 つ以上のテーマ MOD を取得します。

 wp theme mod get [...] [--field=] [--all] [--format=]

オプション

 [...]
	One or more mods to get.

[--field=]
	Returns the value of a single field.

[--all]
	List all theme mods

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - json
	  - csv
	  - yaml
	---

例

 # Get all theme mods.
$ wp theme mod get --all
+------------------+---------+
| key              | value   |
+------------------+---------+
| background_color | dd3333  |
| link_color       | #dd9933 |
| main_text_color  | #8224e3 |
+------------------+---------+

# Get single theme mod in JSON format.
$ wp theme mod get background_color --format=json
[{"key":"background_color","value":"dd3333"}]

# Get value of a single theme mod.
$ wp theme mod get background_color --field=value
dd3333

# Get multiple theme mods.
$ wp theme mod get background_color header_textcolor
+------------------+--------+
| key              | value  |
+------------------+--------+
| background_color | dd3333 |
| header_textcolor |        |
+------------------+--------+

WPテーマMODセット

テーマ MOD の値を設定します。

 wp theme mod set

オプション

 
	The name of the theme mod to set or update.


	The new value.

例

 # Set theme mod
$ wp theme mod set background_color 000000
Success: Theme mod background_color set to 000000.

WPテーマMODを削除

1 つ以上のテーマ MOD を削除します。

 wp theme mod remove [...] [--all]

オプション

 [...]
	One or more mods to remove.

[--all]
	Remove all theme mods.

例

 # Remove all theme mods.
$ wp theme mod remove --all
Success: Theme mods removed.

# Remove single theme mod.
$ wp theme mod remove background_color
Success: 1 mod removed.

# Remove multiple theme mods.
$ wp theme mod remove background_color header_textcolor
Success: 2 mods removed.

WPテーマのパス

テーマまたはテーマディレクトリへのパスを取得します。

 wp theme path [] [--dir]

オプション

 []
	The theme to get the path to. Path includes "style.css" file.
	If not set, will return the path to the themes directory.

[--dir]
	If set, get the path to the closest parent directory, instead of the
	theme's "style.css" file.

例

 # Get theme path
$ wp theme path
/var/www/example.com/public_html/wp-content/themes

# Change directory to theme path
$ cd $(wp theme path)

WPテーマ検索

WordPress.org テーマディレクトリを検索します。

 wp theme search  [--page=] [--per-page=] [--field=] [--fields=] [--format=]

指定された検索クエリに一致する WordPress.org テーマディレクトリ内のテーマを表示します。

オプション

 
	The string to search for.

[--page=]
	Optional page to display.
	---
	default: 1
	---

[--per-page=]
	Optional number of results to display. Defaults to 10.

[--field=]
	Prints the value of a single field for each theme.

[--fields=]
	Ask for specific fields from the API. Defaults to name,slug,author,rating. Acceptable values:

**name**: Theme Name
**slug**: Theme Slug
**version**: Current Version Number
**author**: Theme Author
**preview_url**: Theme Preview URL
**screenshot_url**: Theme Screenshot URL
**rating**: Theme Rating
**num_ratings**: Number of Theme Ratings
**homepage**: Theme Author's Homepage
**description**: Theme Description
**url**: Theme's URL on wordpress.org

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - count
	  - yaml
	---

例

 $ wp theme search photo --per-page=6
Success: Showing 6 of 203 themes.
+----------------------+----------------------+--------+
| name                 | slug                 | rating |
+----------------------+----------------------+--------+
| Photos               | photos               | 100    |
| Infinite Photography | infinite-photography | 100    |
| PhotoBook            | photobook            | 100    |
| BG Photo Frame       | bg-photo-frame       | 0      |
| fPhotography         | fphotography         | 0      |
| Photo Perfect        | photo-perfect        | 98     |
+----------------------+----------------------+--------+

WPテーマのステータス

1 つまたはすべてのテーマのステータスを表示します。

 wp theme status []

オプション

 []
	A particular theme to show the status for.

例

 $ wp theme status twentysixteen
Theme twentysixteen details:
     Name: Twenty Sixteen
     Status: Inactive
     Version: 1.2
     Author: the WordPress team

WPテーマのアップデート

1 つ以上のテーマを更新します。

 wp theme update [...] [--all] [--exclude=] [--minor] [--patch] [--format=] [--version=] [--dry-run] [--insecure]

オプション

 [...]
	One or more themes to update.

[--all]
	If set, all themes that have updates will be updated.

[--exclude=]
	Comma separated list of theme names that should be excluded from updating.

[--minor]
	Only perform updates for minor releases (e.g. from 1.3 to 1.4 instead of 2.0)

[--patch]
	Only perform updates for patch releases (e.g. from 1.3 to 1.3.3 instead of 1.4)

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - summary
	---

[--version=]
	If set, the theme will be updated to the specified version.

[--dry-run]
	Preview which themes would be updated.

[--insecure]
	Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

例

 # Update multiple themes
$ wp theme update twentyfifteen twentysixteen
Downloading update from https://downloads.wordpress.org/theme/twentyfifteen.1.5.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the theme...
Theme updated successfully.
Downloading update from https://downloads.wordpress.org/theme/twentysixteen.1.2.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the theme...
Theme updated successfully.
+---------------+-------------+-------------+---------+
| name          | old_version | new_version | status  |
+---------------+-------------+-------------+---------+
| twentyfifteen | 1.4         | 1.5         | Updated |
| twentysixteen | 1.1         | 1.2         | Updated |
+---------------+-------------+-------------+---------+
Success: Updated 2 of 2 themes.

# Exclude themes updates when bulk updating the themes
$ wp theme update --all --exclude=twentyfifteen
Downloading update from https://downloads.wordpress.org/theme/astra.1.0.5.1.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the theme...
Theme updated successfully.
Downloading update from https://downloads.wordpress.org/theme/twentyseventeen.1.2.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the theme...
Theme updated successfully.
+-----------------+----------+---------+----------------+
| name            | status   | version | update_version |
+-----------------+----------+---------+----------------+
| astra           | inactive | 1.0.1   | 1.0.5.1        |
| twentyseventeen | inactive | 1.1     | 1.2            |
+-----------------+----------+---------+----------------+
Success: Updated 2 of 2 themes.

# Update all themes
$ wp theme update --all

WPテーマMODリスト

テーマ MOD のリストを取得します。

 wp theme mod list [--field=] [--format=]

オプション

 [--field=]
	Returns the value of a single field.

[--format=]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - json
	  - csv
	  - yaml
	---

例

 # Gets a list of theme mods.
$ wp theme mod list
+------------------+---------+
| key              | value   |
+------------------+---------+
| background_color | dd3333  |
| link_color       | #dd9933 |
| main_text_color  | #8224e3 |
+------------------+---------+

インストール中

このパッケージは WP-CLI 自体に含まれているため、追加のインストールは必要ありません。

WP-CLI に含まれているものの上にこのパッケージの最新バージョンをインストールするには、次を実行します。

 wp package install [email protected]:wp-cli/extension-command.git

貢献する

このプロジェクトに積極的に貢献していただきありがとうございます。

貢献はコードだけに限定されません。チュートリアルを作成したり、地元の交流会でデモを行ったり、他のユーザーのサポートに関する質問を支援したり、ドキュメントを改訂したりするなど、自分の能力に最も適した方法で貢献することをお勧めします。

より完全な紹介については、WP-CLI の貢献ガイドを確認してください。このパッケージは、これらのポリシーとガイドラインに従っています。

バグの報告

バグを見つけたと思いますか?問題の解決にご協力いただければ幸いです。

新しい問題を作成する前に、既存の問題を検索して、既存の解決策があるかどうか、または新しいバージョンですでに修正されているかどうかを確認する必要があります。

少し検索を行って、バグの未解決の問題や修正された問題がないことがわかったら、新しい問題を作成してください。できる限り詳細を記載し、可能であれば再現手順を明確にします。詳細については、バグレポートのドキュメントを参照してください。

プルリクエストの作成

新しい機能に貢献したいですか?まず新しい問題を開いて、その機能がプロジェクトに適しているかどうかを話し合ってください。

プルリクエストを最後まで確認することに時間を割くと決めたら、プルリクエストを作成するためのガイドラインに従って、快適なエクスペリエンスを実現してください。このパッケージをローカルで操作する場合の詳細については、「セットアップ」を参照してください。

サポート

GitHub の問題は一般的なサポートの質問には対応していませんが、他の場所で試すことができます: https://wp-cli.org/#support

この README.md は、 wp scaffold package-readme (doc) を使用してプロジェクトのコードベースから動的に生成されます。変更を提案するには、コードベースの対応する部分に対してプルリクエストを送信してください。

拡大する