WP_CLI::debug() Edit

Display debug message prefixed with "Debug: " when --debug is used.


WP_CLI::debug( $message, $group = false )
$message (string|WP_Error|Exception|Throwable) Message to write to STDERR.
$group (string|bool) Organize debug message to a specific group.
@return (null)

Top ↑


Debug message is written to STDERR, and includes script execution time.

Helpful for optionally showing greater detail when needed. Used throughout
WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ bootstrap process for easier debugging and profiling.

# Called in `WP_CLI\Runner::set_wp_root()`.
private static function set_wp_root( $path ) {
    define( 'ABSPATH', Utils\trailingslashit( $path ) );
    WP_CLI::debug( 'ABSPATH defined: ' . ABSPATH );
    $_SERVER['DOCUMENT_ROOT'] = realpath( $path );

# Debug details only appear when `--debug` is used.
# $ wp --debug
# [...]
# Debug: ABSPATH defined: /srv/www/wordpress-develop.dev/src/ (0.225s)

Use false to not group the message.

Internal APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.

Top ↑

  • WP_CLI\Utils\format_items() – Render a collection of items as an ASCII table, JSONJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML., CSV, YAML, list of ids, or count.
  • WP_CLI\Utils\make_progress_bar() – Create a progress bar to display percent completion of a given operation.
  • WP_CLI::colorize() – Colorize a string for output.
  • WP_CLI::line() – Display informational message without prefix, and ignore `–quiet`.
  • WP_CLI::log() – Display informational message without prefix.
  • WP_CLI::success() – Display success message prefixed with "Success: ".
  • WP_CLI::warning() – Display warning message prefixed with "Warning: ".
  • WP_CLI::error() – Display error message prefixed with "Error: " and exit script.
  • WP_CLI::halt() – Halt script execution with a specific return code.
  • WP_CLI::error_multi_line() – Display a multi-line error message in a red box. Doesn’t exit script.

Last updated: