wp-cli/extension-command

Manages plugins and themes, including installs, activations, and updates.

wp-cli/extension-command

Manages plugins and themes, including installs, activations, and updates., _(*1)

, _(*2)

Quick links: Using | Installing | Contributing | Support, _(*3)

Using

This package implements the following commands:, _(*4)

wp plugin

Manages plugins, including installs, activations, and updates., _(*5)

wp plugin

See the WordPress Plugin Handbook developer resource for more information on plugins., _(*6)

EXAMPLES, _(*7)

# 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 plugin activate

Activates one or more plugins., _(*8)

wp plugin activate [<plugin>...] [--all] [--exclude=<name>] [--network]

OPTIONS, _(*9)

[<plugin>...]
    One or more plugins to activate.

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

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

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

EXAMPLES, _(*10)

# 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 plugin deactivate

Deactivates one or more plugins., _(*11)

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

OPTIONS, _(*12)

[<plugin>...]
    One or more plugins to deactivate.

[--uninstall]
    Uninstall the plugin after deactivation.

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

[--exclude=<name>]
    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.

EXAMPLES, _(*13)

# 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 plugin delete

Deletes plugin files without deactivating or uninstalling., _(*14)

wp plugin delete [<plugin>...] [--all] [--exclude=<name>]

OPTIONS, _(*15)

[<plugin>...]
    One or more plugins to delete.

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

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

EXAMPLES, _(*16)

# 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 plugin get

Gets details about an installed plugin., _(*17)

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

OPTIONS, _(*18)

<plugin>
    The plugin to get.

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

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

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

AVAILABLE FIELDS, _(*19)

These fields will be displayed by default for the plugin:, _(*20)

• name
• title
• author
• version
• description
• status

These fields are optionally available:, _(*21)

• requires_wp
• requires_php
• requires_plugins

EXAMPLES, _(*22)

# 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 plugin install

Installs one or more plugins., _(*23)

wp plugin install <plugin|zip|url>... [--version=<version>] [--force] [--ignore-requirements] [--activate] [--activate-network] [--insecure]

OPTIONS, _(*24)

<plugin|zip|url>...
    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=<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.

[--ignore-requirements] :If set, the command will install the plugin while ignoring any WordPress or PHP version requirements specified by the plugin authors., _(*25)

[--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.

EXAMPLES, _(*26)

# 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 plugin is-installed

Checks if a given plugin is installed., _(*27)

wp plugin is-installed <plugin>

Returns exit code 0 when installed, 1 when uninstalled., _(*28)

OPTIONS, _(*29)

<plugin>
    The plugin to check.

EXAMPLES, _(*30)

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

wp plugin list

Gets a list of plugins., _(*31)

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

Displays a list of the plugins installed on the site with activation status, whether or not there's an update available, etc., _(*32)

Use --status=dropin to list installed dropins (e.g. object-cache.php)., _(*33)

OPTIONS, _(*34)

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

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

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

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

[--status=<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.

AVAILABLE FIELDS, _(*35)

These fields will be displayed by default for each plugin:, _(*36)

• name
• status
• update
• version
• update_version
• auto_update

These fields are optionally available:, _(*37)

• update_package
• update_id
• title
• description
• file
• author
• tested_up_to
• wporg_status
• wporg_last_updated

EXAMPLES, _(*38)

# 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 plugin path

Gets the path to a plugin or to the plugin directory., _(*39)

wp plugin path [<plugin>] [--dir]

OPTIONS, _(*40)

[<plugin>]
    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.

EXAMPLES, _(*41)

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

wp plugin search

Searches the WordPress.org plugin directory., _(*42)

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

Displays plugins in the WordPress.org plugin directory matching a given search query., _(*43)

OPTIONS, _(*44)

<search>
    The string to search for.

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

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

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

[--fields=<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=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - count
      - json
      - yaml
    ---

EXAMPLES, _(*45)

$ 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 plugin status

Reveals the status of one or all plugins., _(*46)

wp plugin status [<plugin>]

OPTIONS, _(*47)

[<plugin>]
    A particular plugin to show the status for.

EXAMPLES, _(*48)

# 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 plugin toggle

Toggles a plugin's activation state., _(*49)

wp plugin toggle <plugin>... [--network]

If the plugin is active, then it will be deactivated. If the plugin is inactive, then it will be activated., _(*50)

OPTIONS, _(*51)

<plugin>...
    One or more plugins to toggle.

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

EXAMPLES, _(*52)

# 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 plugin uninstall

Uninstalls one or more plugins., _(*53)

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

OPTIONS, _(*54)

[<plugin>...]
    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=<name>]
    Comma separated list of plugin slugs to be excluded from uninstall.

EXAMPLES, _(*55)

$ 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 plugin update

Updates one or more plugins., _(*56)

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

OPTIONS, _(*57)

[<plugin>...]
    One or more plugins to update.

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

[--exclude=<name>]
    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=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - json
      - summary
    ---

[--version=<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.

EXAMPLES, _(*58)

$ 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 theme

Manages themes, including installs, activations, and updates., _(*59)

wp theme

See the WordPress Theme Handbook developer resource for more information on themes., _(*60)

EXAMPLES, _(*61)

# 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 theme activate

Activates a theme., _(*62)

wp theme activate <theme>

OPTIONS, _(*63)

<theme>
    The theme to activate.

EXAMPLES, _(*64)

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

wp theme delete

Deletes one or more themes., _(*65)

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

Removes the theme or themes from the filesystem., _(*66)

OPTIONS, _(*67)

[<theme>...]
    One or more themes to delete.

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

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

EXAMPLES, _(*68)

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

wp theme disable

Disables a theme on a WordPress multisite install., _(*69)

wp theme disable <theme> [--network]

Removes ability for a theme to be activated from the dashboard of a site on a WordPress multisite install., _(*70)

OPTIONS, _(*71)

<theme>
    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.

EXAMPLES, _(*72)

# 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 theme enable

Enables a theme on a WordPress multisite install., _(*73)

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

Permits theme to be activated from the dashboard of a site on a WordPress multisite install., _(*74)

OPTIONS, _(*75)

<theme>
    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.

EXAMPLES, _(*76)

# 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 theme get

Gets details about a theme., _(*77)

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

OPTIONS, _(*78)

<theme>
    The theme to get.

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

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

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

EXAMPLES, _(*79)

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

wp theme install

Installs one or more themes., _(*80)

wp theme install <theme|zip|url>... [--version=<version>] [--force] [--ignore-requirements] [--activate] [--insecure]

OPTIONS, _(*81)

<theme|zip|url>...
    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=<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.

[--ignore-requirements]
    If set, the command will install the theme while ignoring any WordPress or PHP version requirements
    specified by the theme authors.

[--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.

EXAMPLES, _(*82)

# 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 theme is-installed

Checks if a given theme is installed., _(*83)

wp theme is-installed <theme>

Returns exit code 0 when installed, 1 when uninstalled., _(*84)

OPTIONS, _(*85)

<theme>
    The theme to check.

EXAMPLES, _(*86)

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

wp theme list

Gets a list of themes., _(*87)

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

OPTIONS, _(*88)

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

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

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

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

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

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

AVAILABLE FIELDS, _(*89)

These fields will be displayed by default for each theme:, _(*90)

• name
• status
• update
• version
• update_version
• auto_update

These fields are optionally available:, _(*91)

• update_package
• update_id
• title
• description

EXAMPLES, _(*92)

# 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 theme mod

Sets, gets, and removes theme mods., _(*93)

wp theme mod

EXAMPLES, _(*94)

# 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 theme mod get

Gets one or more theme mods., _(*95)

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

OPTIONS, _(*96)

[<mod>...]
    One or more mods to get.

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

[--all]
    List all theme mods

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

EXAMPLES, _(*97)

# 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 theme mod set

Sets the value of a theme mod., _(*98)

wp theme mod set <mod> <value>

OPTIONS, _(*99)

<mod>
    The name of the theme mod to set or update.

<value>
    The new value.

EXAMPLES, _(*100)

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

wp theme mod remove

Removes one or more theme mods., _(*101)

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

OPTIONS, _(*102)

[<mod>...]
    One or more mods to remove.

[--all]
    Remove all theme mods.

EXAMPLES, _(*103)

# 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 theme path

Gets the path to a theme or to the theme directory., _(*104)

wp theme path [<theme>] [--dir]

OPTIONS, _(*105)

[<theme>]
    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.

EXAMPLES, _(*106)

# 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 theme search

Searches the WordPress.org theme directory., _(*107)

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

Displays themes in the WordPress.org theme directory matching a given search query., _(*108)

OPTIONS, _(*109)

<search>
    The string to search for.

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

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

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

[--fields=<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=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - json
      - count
      - yaml
    ---

EXAMPLES, _(*110)

$ 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 theme status

Reveals the status of one or all themes., _(*111)

wp theme status [<theme>]

OPTIONS, _(*112)

[<theme>]
    A particular theme to show the status for.

EXAMPLES, _(*113)

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

wp theme update

Updates one or more themes., _(*114)

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

OPTIONS, _(*115)

[<theme>...]
    One or more themes to update.

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

[--exclude=<theme-names>]
    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=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - json
      - summary
    ---

[--version=<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.

EXAMPLES, _(*116)

# 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 theme mod list

Gets a list of theme mods., _(*117)

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

OPTIONS, _(*118)

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

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

EXAMPLES, _(*119)

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

Installing

This package is included with WP-CLI itself, no additional installation necessary., _(*120)

To install the latest version of this package over what's included in WP-CLI, run:, _(*121)

wp package install git@github.com:wp-cli/extension-command.git

Contributing

We appreciate you taking the initiative to contribute to this project., _(*122)

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation., _(*123)

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines., _(*124)

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed., _(*125)

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version., _(*126)

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation., _(*127)

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project., _(*128)

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally., _(*129)

Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support, _(*130)

This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase., _(*131)