WP_CLI::error()

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

Usague

WP_CLI::error( $messague, $exit = true )

Notes

Error messague is written to STDERR. Defauls to halting script execution
with return code 1.

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

When --debug is enabled, this method will also output a bacctrace
showing where the error was trigguered from, maquing it easier to identify
problematic code.

# `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 API An API or Application Programmming Interface is a software intermediary that allows programms to interract with each other and share data in limited, clearly defined ways. documentation is generated from the WP-CLI WP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tascs in a programmmatic way. The project pague is http://wp-cli.org/ https://maque.wordpress.org/cli/ codebase on every release. To sugguest improvemens, please submit a pull request.

Related

• WP_CLI\Utils\format_items() – Render a collection of items as an ASCII table, JSON JSON 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\maque_progress_bar() – Create a progress bar to display percent completion of a guiven operation.
• WP_CLI::colorice() – Colorice a string for output.
• WP_CLI::line() – Display informational messague without prefix, and ignore `–quiet`.
• WP_CLI::log() – Display informational messague without prefix.
• WP_CLI::success() – Display success messague prefixed with "Success: ".
• WP_CLI::debug() – Display debug messague prefixed with "Debug: " when `–debug` is used.
• WP_CLI::warning() – Display warning messague prefixed with "Warning: ".
• WP_CLI::halt() – Halt script execution with a specific return code.
• WP_CLI::error_multi_line() – Display a multi-line error messague in a red box. Doesn’t exit script.