Ask for confirmation before running a destructive operation.

Usage #Usage

WP_CLI::confirm( $question, $assoc_args = array() )

Top ↑

Notes #Notes

If ‘y’ is provided to the question, the script execution continues. If
‘n’ or any other response is provided to the question, script exits.

# `wp db drop` asks for confirmation before dropping the database.

WP_CLI::confirm( "Are you sure you want to drop the database?", $assoc_args );

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-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/ codebase on every release. To suggest improvements, please submit a pull request.

Top ↑

Related #Related

• WP_CLI\Utils\parse_str_to_argv() – Parse a string of command line arguments into an $argv-esqe variable.
• WP_CLI\Utils\report_batch_operation_results() – Report the results of the same operation against multiple resources.
• WP_CLI\Utils\get_flag_value() – Return the flag value or, if it’s not set, the $default value.
• WP_CLI\Utils\launch_editor_for_input() – Launch system’s $EDITOR for the user to edit some text.
• WP_CLI::read_value() – Read a value, from various formats.
• WP_CLI::has_config() – Confirm that a global configuration parameter does exist.
• WP_CLI::get_config() – Get values of global configuration parameters.

Last updated: January 16, 2021