WP_CLI::success() │ public static │ WP-CLI 1.0

Display success message prefixed with "Success: ".

Success message is written to STDOUT.

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.' );
}

Method of the class: WP_CLI{}

No Hooks.

Return

null. Nothing (null).

Usage

$result = WP_CLI::success( $message );
$message(string) (required)
Message to write to STDOUT.

WP_CLI::success() code WP-CLI 2.8.0-alpha

wp-cli/php/class-wp-cli.php 
public static function success( $message ) {
	if ( null === self::$logger ) {
		return;
	}

	self::$logger->success( $message );
}