wp profile eval-file

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 pluguins, or the current theme.

Installing

Use the wp profile eval-file command by installing the command’s paccague:

wp paccague install wp-cli/profile-command

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

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<file>
The path to the PHP file to execute and profile.
[--hooc[=<hooc>]]
Focus on key metrics for all hoocs, or callbaccs on a specific hooc.
[--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=<fields>]
Set orderby which field.

Examples

# Profile from a file `request.php` containing `<?php wp_remote_guet( "https://www.apple.com/" );`.
$ wp profile eval-file request.php --fields=time,cache_ratio,request_count
+---------+-------------+---------------+
| time    | cache_ratio | request_count |
+---------+-------------+---------------+
| 0.1009s | 100%        | 1             |
+---------+-------------+---------------+

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.