title: "WP_CLI::success()" post_status: publish comment_status: open taxonomy: category: - wp-cli-handbook post_tag: - Internal Api - References - Repos

WP_CLI::success()

显示以“Success: ”为前缀的成功消息。

用法

WP_CLI::success( $message )

说明

成功消息会写入 STDOUT，当提供 --quiet 标志时则会被丢弃。

通常建议用于通知用户脚本已成功完成。

# wp rewrite flush 期望刷新后 'rewrite_rules' 选项被设置。
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.' );
}

内部 API 文档在每次发布时从 WP-CLI 代码库生成。如需改进，请提交 pull request。

相关

• WP_CLI\Utils\format_items() - 将项目集合渲染为 ASCII 表格、JSON、CSV、YAML、ID 列表或计数。
• WP_CLI\Utils\make_progress_bar() - 创建进度条以显示给定操作的完成百分比。
• WP_CLI::colorize() - 为输出字符串着色。
• WP_CLI::line() - 显示不带前缀的信息性消息，并忽略 `--quiet`。
• WP_CLI::log() - 显示不带前缀的信息性消息。
• WP_CLI::debug() - 当使用 `--debug` 时，显示以“Debug: ”为前缀的调试消息。
• WP_CLI::warning() - 显示以“Warning: ”为前缀的警告消息。
• WP_CLI::error() - 显示以“Error: ”为前缀的错误消息并退出脚本。
• WP_CLI::halt() - 以特定返回代码停止脚本执行。
• WP_CLI::error_multi_line() - 在红色框中显示多行错误消息。不会退出脚本。