mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-04-29 14:14:51 +08:00
264cb131bf
- Organize files in folders according to the desired structure - Use directory iterator to loop through all files and folders (makes generation more robust)
2.8 KiB
2.8 KiB
WP_CLI::success()
Display success message prefixed with "Success: ".
Usage
WP_CLI::success( $message )
$message (string) Message to write to STDOUT.
@return (void)
@return (void)
Notes
Success message is written to STDOUT, or discarded when --quiet flag is supplied.
Typically recommended to inform user of successful script conclusion.
# wp rewrite flush expects 'rewrite_rules' option to be set after flush.
flush_rewrite_rules( \WP_CLI\Utils\get_flag_value( $assoc_args, 'hard' ) );
if ( ! get_option( 'rewrite_rules' ) ) {
WP_CLI::warning( "Rewrite rules are empty." );
} else {
WP_CLI::success( 'Rewrite rules flushed.' );
}
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::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::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.
