云策 WordPress 开发者社区

类文档

WP_HTTP_Requests_Response

查看官方原文 ↗
💡 云策文档标注

概述

WP_HTTP_Requests_Response 是 WordPress 中用于标准化 WpOrgRequestsResponse 的核心包装类，继承自 WP_HTTP_Response。它提供了一系列方法来处理 HTTP 响应的数据、头部、状态码和 Cookie。

关键要点

  • WP_HTTP_Requests_Response 继承自 WP_HTTP_Response，用于封装 WpOrgRequestsResponse 对象。
  • 主要方法包括获取和设置响应数据、头部、状态码、Cookie，以及转换为 WP_Http 响应数组。
  • 支持处理大小写不敏感的头部，并可将响应转换为标准数组格式。

代码示例

// 示例：创建 WP_HTTP_Requests_Response 对象并获取数据
$response = new WP_HTTP_Requests_Response($requests_response, 'filename.txt');
$data = $response->get_data();
$headers = $response->get_headers();
$status = $response->get_status();
$cookies = $response->get_cookies();
$array = $response->to_array();

注意事项

  • 构造函数接受 WpOrgRequestsResponse 对象和可选文件名参数。
  • get_headers() 方法返回大小写不敏感的头部字典，确保兼容性。
  • to_array() 方法生成符合 WP_Http::request() 格式的响应数组，便于集成。
📄 原文内容

Core wrapper object for a WpOrgRequestsResponse for standardization.

Description

See also

Methods

Name Description
WP_HTTP_Requests_Response::__construct Constructor.
WP_HTTP_Requests_Response::get_cookies Retrieves cookies from the response.
WP_HTTP_Requests_Response::get_data Retrieves the response data.
WP_HTTP_Requests_Response::get_headers Retrieves headers associated with the response.
WP_HTTP_Requests_Response::get_response_object Retrieves the response object for the request.
WP_HTTP_Requests_Response::get_status Retrieves the HTTP return code for the response.
WP_HTTP_Requests_Response::header Sets a single HTTP header.
WP_HTTP_Requests_Response::set_data Sets the response data.
WP_HTTP_Requests_Response::set_headers Sets all header values.
WP_HTTP_Requests_Response::set_status Sets the 3-digit HTTP status code.
WP_HTTP_Requests_Response::to_array Converts the object to a WP_Http response array.

Source

class WP_HTTP_Requests_Response extends WP_HTTP_Response {
	/**
	 * Requests Response object.
	 *
	 * @since 4.6.0
	 * @var WpOrgRequestsResponse
	 */
	protected $response;

	/**
	 * Filename the response was saved to.
	 *
	 * @since 4.6.0
	 * @var string|null
	 */
	protected $filename;

	/**
	 * Constructor.
	 *
	 * @since 4.6.0
	 *
	 * @param WpOrgRequestsResponse $response HTTP response.
	 * @param string                   $filename Optional. File name. Default empty.
	 */
	public function __construct( WpOrgRequestsResponse $response, $filename = '' ) {
		$this->response = $response;
		$this->filename = $filename;
	}

	/**
	 * Retrieves the response object for the request.
	 *
	 * @since 4.6.0
	 *
	 * @return WpOrgRequestsResponse HTTP response.
	 */
	public function get_response_object() {
		return $this->response;
	}

	/**
	 * Retrieves headers associated with the response.
	 *
	 * @since 4.6.0
	 *
	 * @return WpOrgRequestsUtilityCaseInsensitiveDictionary Map of header name to header value.
	 */
	public function get_headers() {
		// Ensure headers remain case-insensitive.
		$converted = new WpOrgRequestsUtilityCaseInsensitiveDictionary();

		foreach ( $this->response->headers->getAll() as $key => $value ) {
			if ( count( $value ) === 1 ) {
				$converted[ $key ] = $value[0];
			} else {
				$converted[ $key ] = $value;
			}
		}

		return $converted;
	}

	/**
	 * Sets all header values.
	 *
	 * @since 4.6.0
	 *
	 * @param array $headers Map of header name to header value.
	 */
	public function set_headers( $headers ) {
		$this->response->headers = new WpOrgRequestsResponseHeaders( $headers );
	}

	/**
	 * Sets a single HTTP header.
	 *
	 * @since 4.6.0
	 *
	 * @param string $key     Header name.
	 * @param string $value   Header value.
	 * @param bool   $replace Optional. Whether to replace an existing header of the same name.
	 *                        Default true.
	 */
	public function header( $key, $value, $replace = true ) {
		if ( $replace ) {
			unset( $this->response->headers[ $key ] );
		}

		$this->response->headers[ $key ] = $value;
	}

	/**
	 * Retrieves the HTTP return code for the response.
	 *
	 * @since 4.6.0
	 *
	 * @return int The 3-digit HTTP status code.
	 */
	public function get_status() {
		return $this->response->status_code;
	}

	/**
	 * Sets the 3-digit HTTP status code.
	 *
	 * @since 4.6.0
	 *
	 * @param int $code HTTP status.
	 */
	public function set_status( $code ) {
		$this->response->status_code = absint( $code );
	}

	/**
	 * Retrieves the response data.
	 *
	 * @since 4.6.0
	 *
	 * @return string Response data.
	 */
	public function get_data() {
		return $this->response->body;
	}

	/**
	 * Sets the response data.
	 *
	 * @since 4.6.0
	 *
	 * @param string $data Response data.
	 */
	public function set_data( $data ) {
		$this->response->body = $data;
	}

	/**
	 * Retrieves cookies from the response.
	 *
	 * @since 4.6.0
	 *
	 * @return WP_HTTP_Cookie[] List of cookie objects.
	 */
	public function get_cookies() {
		$cookies = array();
		foreach ( $this->response->cookies as $cookie ) {
			$cookies[] = new WP_Http_Cookie(
				array(
					'name'      => $cookie->name,
					'value'     => urldecode( $cookie->value ),
					'expires'   => isset( $cookie->attributes['expires'] ) ? $cookie->attributes['expires'] : null,
					'path'      => isset( $cookie->attributes['path'] ) ? $cookie->attributes['path'] : null,
					'domain'    => isset( $cookie->attributes['domain'] ) ? $cookie->attributes['domain'] : null,
					'host_only' => isset( $cookie->flags['host-only'] ) ? $cookie->flags['host-only'] : null,
				)
			);
		}

		return $cookies;
	}

	/**
	 * Converts the object to a WP_Http response array.
	 *
	 * @since 4.6.0
	 *
	 * @return array WP_Http response array, per WP_Http::request().
	 */
	public function to_array() {
		return array(
			'headers'  => $this->get_headers(),
			'body'     => $this->get_data(),
			'response' => array(
				'code'    => $this->get_status(),
				'message' => get_status_header_desc( $this->get_status() ),
			),
			'cookies'  => $this->get_cookies(),
			'filename' => $this->filename,
		);
	}
}

View all references View on Trac View on GitHub

Uses Description
WP_HTTP_Responsewp-includes/class-wp-http-response.php

Core class used to prepare HTTP responses.

Changelog

Version Description
4.6.0 Introduced.