WP-CLI

A command line interface for WordPress

Docs » Internal API » Output

WP_CLI::error()

Display error message prefixed with "Error: " and exit script.


Usage

WP_CLI::error( $message, $exit = true )
$message (string|WP_Error) Message to write to STDERR.
$exit (boolean|integer) True defaults to exit(1).
@return (null)

Notes

Error message is written to STDERR. Defaults to halting script execution with return code 1.

Use WP_CLI::warning() instead when script execution should be permitted to continue.

# `wp cache flush` considers flush failure to be a fatal error.
if ( false === wp_cache_flush() ) {
    WP_CLI::error( 'The object cache could not be flushed.' );
}

Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.