Profile key metrics for WordPress hooks (actions and filters).

In order to profile callbacks on a specific hook, the action or filter will need to execute during the course of the request.

INSTALLING #INSTALLING

Use the wp profile hook command by installing the command's package:

wp package install wp-cli/profile-command

Once the package is successfully installed, the wp profile hook command will appear in the list of available commands.

Top ↑

OPTIONS #OPTIONS

[<hook>]

Drill into key metrics of callbacks on a specific WordPress hook.

[--all]

Profile callbacks for all WordPress hooks.

[--spotlight]

Filter out logs with zero-ish values from the set.

[--url=<url>]

Execute a request against a specified URL. Defaults to the home URL.

[--fields=<fields>]

Display one or more fields.

[--format=<format>]

Render output in a particular format.
---
default: table
options:
– table
– json
– yaml
– csv
---

[--order=<order>]

Ascending or Descending order.
---
default: ASC
options:
– ASC
– DESC
---

[--orderby=<orderby>]

Order by fields.

Top ↑

GLOBAL PARAMETERS #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”, “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.

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.