WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp icon get

wp icon get

Gets details about a registered icon.

In this article

Back to top

GitHub
View Open Issues (0) View Closed Issues (0) Create New Issue
Note: This command is not part of a stable WP-CLI release yet. To use it now, switch to the nightly build with wp cli update --nightly. If you installed the command as a separate package, updating that package may be enough.

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<name>
Namespaced icon name, in the form “collection/icon-name”.
[–field=<field>]
Instead of returning the whole icon, returns the value of a single field.
[–fields=<fields>]
Limit the output to specific fields.
[–format=<format>]
Render output in a particular format. — default: table options: – table – csv – json – yaml —

Available Fields

These fields will be displayed by default for the specified icon:
  • name
  • label
  • collection
  • content
This field is optionally available:
  • file_path

Examples

# Get details of a specific icon
$ wp icon get core/plus --fields=name,label,collection
+------------+-----------+
| Field      | Value     |
+------------+-----------+
| name       | core/plus |
| label      | Plus      |
| collection | core      |
+------------+-----------+

# Get the SVG markup of an icon, as it was registered
$ wp icon get core/plus --field=content
&lt;svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24"&gt;
    &lt;path d="M11 12.5V17.5H12.5V12.5H17.5V11H12.5V6H11V11H6V12.5H11Z" /&gt;
&lt;/svg&gt;

# Find out where an icon is loaded from
$ wp icon get core/plus --field=file_path
/var/www/html/wp-includes/images/icon-library/plus.svg

Global Parameters

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”).
--ssh-args=<args> Pass additional arguments to SSH (or other tools specified by –ssh scheme).
--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.
--alias=<name> Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file.
--assume-https Set $_SERVER[‘HTTPS’] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer.

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