概述

rest_handle_deprecated_argument() 是 WordPress REST API 中用于处理已弃用参数错误的函数。它根据调试模式和消息内容，生成并发送包含弃用信息的 HTTP 头。

关键要点

• 函数接受三个参数：$function_name（函数名）、$message（消息）和 $version（版本），均为必需字符串。
• 仅在 WP_DEBUG 启用且 HTTP 头未发送时执行，否则直接返回。
• 根据 $message 是否为空，生成不同的翻译字符串，并设置 X-WP-DeprecatedParam 头。
• 该函数自 WordPress 4.4.0 版本引入。

代码示例

function rest_handle_deprecated_argument( $function_name, $message, $version ) {
    if ( ! WP_DEBUG || headers_sent() ) {
        return;
    }
    if ( $message ) {
        /* translators: 1: Function name, 2: WordPress version number, 3: Error message. */
        $string = sprintf( __( '%1$s (since %2$s; %3$s)' ), $function_name, $version, $message );
    } else {
        /* translators: 1: Function name, 2: WordPress version number. */
        $string = sprintf( __( '%1$s (since %2$s; no alternative available)' ), $function_name, $version );
    }
    header( sprintf( 'X-WP-DeprecatedParam: %s', $string ) );
}