See the argument syntax reference for a detailed explanation of the syntax conventions used.
- <slug>
- The category slug.
- [--field=<field>]
- Instead of returning the whole category, 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
—
- slug
- label
- description
- meta
# Get details of a specific category.
$ wp ability category get site
+-------------+-----------------------------------------------------+
| Field | Value |
+-------------+-----------------------------------------------------+
| slug | site |
| label | Site |
| description | Abilities that retrieve or modify site information. |
| meta | {} |
+-------------+-----------------------------------------------------+
# Get category as JSON.
$ wp ability category get site --format=json
{"slug":"site","label":"Site","description":"...","meta":"{}"}
# Get only the label.
$ wp ability category get site --field=label
Site
These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
| Argument |
Description |
--path=<path> |
Path to the WordPress files. |
--url=<url> |
Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] |
Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “docker-compose-run”, “vagrant”). |
--http=<http> |
Perform operation against a remote WordPress installation over HTTP. |
--user=<id\|login\|email> |
Set the WordPress user. |
--skip-plugins[=<plugins>] |
Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
--skip-themes[=<themes>] |
Skip loading all themes, or a comma-separated list of themes. |
--skip-packages |
Skip loading all installed packages. |
--require=<path> |
Load PHP file before running the command (may be used more than once). |
--exec=<php-code> |
Execute PHP code before running the command (may be used more than once). |
--context=<context> |
Load WordPress in a given context. |
--[no-]color |
Whether to colorize the output. |
--debug[=<group>] |
Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
--prompt[=<assoc>] |
Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
--quiet |
Suppress informational messages. |
