WP-CLI 命令行手册

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

WP_CLI::debug()

当使用 --debug 参数时，显示以“Debug: ”为前缀的调试信息。

用法

WP_CLI::debug( $message, $group = false )
$message (string|WP_Error|Exception|Throwable) 要写入 STDERR 的消息。
$group (string|bool) 将调试信息组织到特定分组。
@return (void)

说明

调试信息会写入 STDERR，并包含脚本执行时间。

有助于在需要时选择性地显示更多细节。在整个 WP-CLI 引导过程中使用，以便于调试和性能分析。

# 在 `WP_CLI\Runner::set_wp_root()` 中调用。
private static function set_wp_root( $path ) {
    define( 'ABSPATH', Utils\trailingslashit( $path ) );
    WP_CLI::debug( 'ABSPATH defined: ' . ABSPATH );
    $_SERVER['DOCUMENT_ROOT'] = realpath( $path );
}

# 仅在使用 `--debug` 时显示调试详情。
# $ wp --debug
# [...]
# Debug: ABSPATH defined: /srv/www/wordpress-develop.dev/src/ (0.225s)

使用 false 可以不将消息分组。

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

相关