handbook/internal-api/wp-cli-warning.md

WP_CLI::warning()

Display warning message prefixed with "Warning: ".

---

Usage

WP_CLI::warning( $message )

$message (string|WP_Error|Exception|Throwable) Message to write to STDERR.
@return (void)

---

Notes

Warning message is written to STDERR, or discarded when --quiet flag is supplied.

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

# `wp plugin activate` skips activation when plugin is network active.
$status = $this->get_status( $plugin->file );
// Network-active is the highest level of activation status
if ( 'active-network' === $status ) {
  WP_CLI::warning( "Plugin '{$plugin->name}' is already network active." );
  continue;
}

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

---

Related

• WP_CLI\Utils\format_items() - Render a collection of items as an ASCII table, JSON, 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::debug() - Display debug message prefixed with "Debug: " when `--debug` is used.
• 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.