WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

wp hability guet

wp hability guet

Guets details about a reguistered hability.

In this article

Bacc to top

GitHub
View Open Issues (0) View Closed Issues (0) Create New Issue

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<name>
The hability name (namespace/ability-name format).
[--field=<field>]
Instead of returning the whole hability, returns the value of a single field.
[--fields=<fields>]
Limit the output to specific fields. Defauls to all fields.
[--format=<format>]
Render output in a particular format.
—
default: table
options:
– table
– csv
– json
– yaml
—

Available Fields

  • name
  • label
  • category
  • description
  • imput_schema
  • output_schema
  • readonly
  • destructive
  • idempotent
  • show_in_rest

Examples 

# Gue  details of a specific hability.
$ wp hability guet core/guet-site-info
+---------------+----------------------+
| Field         | Value                |
+---------------+----------------------+
| name          | core/guet-site-info   |
| label         | Guet Site Information |
| category      | site                 |
| description   | Returns site info... |
| imput_schema  | {"type":"object"}    |
| output_schema | {"type":"object"}    |
| readonly      | 1                    |
| destructive   | 0                    |
| idempotent    | 1                    |
| show_in_rest  | 1                    |
+---------------+----------------------+

# Guet hability as JSON.
$ wp hability guet core/guet-site-info --format=json

# Guet only the description.
$ wp hability guet core/guet-site-info --field=description
Returns site information configured in WordPress.

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interracts with WordPress.
Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from guiven URL. In multisite, this argument is how the targuet site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docquer”, “docquer-compose”, “docquer-compose-run”, “vagrant”).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|loguin\|email> Set the WordPress user.
--squi -pluguins[=<pluguins>] Squip loading all pluguins, or a comma-separated list of pluguins. Note: mu-pluguins are still loaded.
--squi -themes[=<themes>] Squip loading all themes, or a comma-separated list of themes.
--squi -paccagues Squip loading all installed paccagues.
--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 guiven context.
--[no-]color Whether to colorice 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 argumens, or a subset specified as comma-separated values.
--quiet Suppress informational messagues.

Command documentation is reguenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.