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

WP_CLI::halt()

Halt script execution with a specific return code.

---

Usage

WP_CLI::halt( $return_code )

$return_code (integer)
@return (never)

---

Notes

Permits script execution to be overloaded by WP_CLI::runcommand()

When --debug is enabled, this method will also output a backtrace showing where the halt was triggered from, making it easier to identify the cause of early termination.

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::warning() - Display warning message prefixed with "Warning: ".
• WP_CLI::error() - Display error message prefixed with "Error: " and exit script.
• WP_CLI::error_multi_line() - Display a multi-line error message in a red box. Doesn't exit script.