Profile execution of an arbitrary file.

File execution happens after WordPress has loaded entirely, which means you can use any utilities defined in WordPress, active plugins, or the current theme.

INSTALLING #INSTALLING

Use the wp profile eval-file command by installing the command's package:

wp package install wp-cli/profile-command

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

Top ↑

OPTIONS #OPTIONS

<file>

The path to the PHP file to execute and profile.

[--hook[=<hook>]]

Focus on key metrics for all hooks, or callbacks on a specific hook.

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