WP_HTTP_IXR_Client
云策文档标注
概述
WP_HTTP_IXR_Client 是 WordPress 中用于 XML-RPC 通信的客户端类,继承自 IXR_Client。它通过 HTTP 发送 XML-RPC 请求并处理响应,适用于远程过程调用场景。
关键要点
- WP_HTTP_IXR_Client 扩展自 IXR_Client,提供基于 HTTP 的 XML-RPC 客户端功能。
- 构造函数 __construct 支持传入服务器地址、路径、端口和超时时间,自动解析 URL 或使用默认 HTTP 方案。
- query 方法用于执行 XML-RPC 调用,内部使用 wp_remote_post 发送请求,并处理错误和响应解析。
- 类包含属性如 $scheme、$error,并支持通过过滤器 wp_http_ixr_client_headers 自定义请求头。
- 调试模式下可输出 XML 请求和响应内容,便于开发排查问题。
代码示例
public function __construct( $server, $path = false, $port = false, $timeout = 15 ) {
if ( ! $path ) {
// Assume we have been given a URL instead.
$bits = parse_url( $server );
$this->scheme = $bits['scheme'];
$this->server = $bits['host'];
$this->port = isset( $bits['port'] ) ? $bits['port'] : $port;
$this->path = ! empty( $bits['path'] ) ? $bits['path'] : '/';
// Make absolutely sure we have a path.
if ( ! $this->path ) {
$this->path = '/';
}
if ( ! empty( $bits['query'] ) ) {
$this->path .= '?' . $bits['query'];
}
} else {
$this->scheme = 'http';
$this->server = $server;
$this->path = $path;
$this->port = $port;
}
$this->useragent = 'The Incutio XML-RPC PHP Library';
$this->timeout = $timeout;
}注意事项
- 使用 query 方法时,需确保服务器支持 XML-RPC 协议,并正确处理返回的 IXR_Error 对象。
- 超时设置通过 $timeout 参数控制,默认 15 秒,可调整以适应网络环境。
- 过滤器 wp_http_ixr_client_headers 允许开发者修改请求头,增强自定义性。
原文内容
Methods
| Name | Description |
|---|---|
| WP_HTTP_IXR_Client::__construct | – |
| WP_HTTP_IXR_Client::query | – |
Source
class WP_HTTP_IXR_Client extends IXR_Client {
public $scheme;
/**
* @var IXR_Error
*/
public $error;
/**
* @param string $server
* @param string|false $path
* @param int|false $port
* @param int $timeout
*/
public function __construct( $server, $path = false, $port = false, $timeout = 15 ) {
if ( ! $path ) {
// Assume we have been given a URL instead.
$bits = parse_url( $server );
$this->scheme = $bits['scheme'];
$this->server = $bits['host'];
$this->port = isset( $bits['port'] ) ? $bits['port'] : $port;
$this->path = ! empty( $bits['path'] ) ? $bits['path'] : '/';
// Make absolutely sure we have a path.
if ( ! $this->path ) {
$this->path = '/';
}
if ( ! empty( $bits['query'] ) ) {
$this->path .= '?' . $bits['query'];
}
} else {
$this->scheme = 'http';
$this->server = $server;
$this->path = $path;
$this->port = $port;
}
$this->useragent = 'The Incutio XML-RPC PHP Library';
$this->timeout = $timeout;
}
/**
* @since 3.1.0
* @since 5.5.0 Formalized the existing `...$args` parameter by adding it
* to the function signature.
*
* @return bool
*/
public function query( ...$args ) {
$method = array_shift( $args );
$request = new IXR_Request( $method, $args );
$xml = $request->getXml();
$port = $this->port ? ":$this->port" : '';
$url = $this->scheme . '://' . $this->server . $port . $this->path;
$args = array(
'headers' => array( 'Content-Type' => 'text/xml' ),
'user-agent' => $this->useragent,
'body' => $xml,
);
// Merge Custom headers ala #8145.
foreach ( $this->headers as $header => $value ) {
$args['headers'][ $header ] = $value;
}
/**
* Filters the headers collection to be sent to the XML-RPC server.
*
* @since 4.4.0
*
* @param string[] $headers Associative array of headers to be sent.
*/
$args['headers'] = apply_filters( 'wp_http_ixr_client_headers', $args['headers'] );
if ( false !== $this->timeout ) {
$args['timeout'] = $this->timeout;
}
// Now send the request.
if ( $this->debug ) {
echo '<pre class="ixr_request">' . htmlspecialchars( $xml ) . "n</pre>nn";
}
$response = wp_remote_post( $url, $args );
if ( is_wp_error( $response ) ) {
$errno = $response->get_error_code();
$errorstr = $response->get_error_message();
$this->error = new IXR_Error( -32300, "transport error: $errno $errorstr" );
return false;
}
if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
$this->error = new IXR_Error( -32301, 'transport error - HTTP status code was not 200 (' . wp_remote_retrieve_response_code( $response ) . ')' );
return false;
}
if ( $this->debug ) {
echo '<pre class="ixr_response">' . htmlspecialchars( wp_remote_retrieve_body( $response ) ) . "n</pre>nn";
}
// Now parse what we've got back.
$this->message = new IXR_Message( wp_remote_retrieve_body( $response ) );
if ( ! $this->message->parse() ) {
// XML error.
$this->error = new IXR_Error( -32700, 'parse error. not well formed' );
return false;
}
// Is the message a fault?
if ( 'fault' === $this->message->messageType ) {
$this->error = new IXR_Error( $this->message->faultCode, $this->message->faultString );
return false;
}
// Message must be OK.
return true;
}
}
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |