wp widget list

Lists widgets associated with a sidebar.

$ wp widget list <sidebar-id> [--fields=<fields>] [--format=<format>]

OPTIONS

<sidebar-id>
ID for the corresponding sidebar.
[--fields=<fields>]
Limit the output to specific object fields.
[--format=<format>]
Render output in a particular format. --- default: table options:
  • table
  • csv
  • ids
  • json
  • count
  • yaml ---

AVAILABLE FIELDS

These fields will be displayed by default for each widget:

  • name
  • id
  • position
  • options

There are no optionally available fields.

EXAMPLES

$ wp widget list sidebar-1 --fields=name,id --format=csv
name,id
meta,meta-5
search,search-3

GLOBAL PARAMETERS

--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", "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).

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

Related commands

Adds a widget to a sidebar.

Deactivates one or more widgets from an active sidebar.

Deletes one or more widgets from a sidebar.

Lists widgets associated with a sidebar.

Moves the position of a widget.

Resets sidebar.

Updates options for an existing widget.