_xmlrpc_wp_die_handler()
云策文档标注
概述
_xmlrpc_wp_die_handler() 是处理 XML-RPC 请求时 wp_die() 的处理器,用于终止 WordPress 执行并显示 XML 格式的错误响应。
关键要点
- 此函数在 XML-RPC 请求中作为 wp_die() 的处理器,输出 XML 错误消息。
- 参数包括必需的 $message(错误消息)、可选的 $title(错误标题)和 $args(控制行为的参数数组)。
- 函数内部调用 _wp_die_process_input() 处理输入参数,设置 nocache_headers() 防止缓存,并通过 IXR_Error 生成 XML 输出。
- 如果 $parsed_args['exit'] 为真,则调用 die() 终止执行。
代码示例
function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
global $wp_xmlrpc_server;
list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
if ( ! headers_sent() ) {
nocache_headers();
}
if ( $wp_xmlrpc_server ) {
$error = new IXR_Error( $parsed_args['response'], $message );
$wp_xmlrpc_server->output( $error->getXml() );
}
if ( $parsed_args['exit'] ) {
die();
}
}注意事项
- 此函数自 WordPress 3.2.0 版本引入,主要用于 XML-RPC 错误处理场景。
- 相关函数包括 _wp_die_process_input()、nocache_headers() 和 IXR_Error 类,开发者应熟悉这些组件以正确使用此处理器。
原文内容
Kills WordPress execution and displays XML response with an error message.
Description
This is the handler for wp_die() when processing XML-RPC requests.
Parameters
$messagestringrequired-
Error message.
$titlestringoptional-
Error title. Default empty string.
$argsstring|arrayoptional-
Arguments to control behavior.
Default:
array()
Source
function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
global $wp_xmlrpc_server;
list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
if ( ! headers_sent() ) {
nocache_headers();
}
if ( $wp_xmlrpc_server ) {
$error = new IXR_Error( $parsed_args['response'], $message );
$wp_xmlrpc_server->output( $error->getXml() );
}
if ( $parsed_args['exit'] ) {
die();
}
}
Changelog
| Version | Description |
|---|---|
| 3.2.0 | Introduced. |