WP_HTTP_Requests_Hooks

💡 云策文档标注

概述

WP_HTTP_Requests_Hooks 是一个桥接类，用于将 Requests 库的内部钩子连接到 WordPress 动作。它扩展自 WpOrgRequestsHooks，允许开发者在 WordPress 环境中处理 HTTP 请求时利用 Requests 的钩子系统。

关键要点

WP_HTTP_Requests_Hooks 继承自 WpOrgRequestsHooks，提供与 WordPress 动作的集成。
主要方法包括 __construct 构造函数和 dispatch 方法，后者用于分发 Requests 钩子到 WordPress 动作。
dispatch 方法处理特定钩子（如 curl.before_send）的向后兼容性，并触发自定义 WordPress 动作（如 requests-{$hook}）。
该类在 WordPress 4.7.0 版本中引入，用于增强 HTTP 请求处理的可扩展性。

代码示例

public function dispatch( $hook, $parameters = array() ) {
    $result = parent::dispatch( $hook, $parameters );

    // Handle back-compat actions.
    switch ( $hook ) {
        case 'curl.before_send':
            /** This action is documented in wp-includes/class-wp-http-curl.php */
            do_action_ref_array( 'http_api_curl', array( &$parameters[0], $this->request, $this->url ) );
            break;
    }

    /**
     * Transforms a native Request hook to a WordPress action.
     *
     * This action maps Requests internal hook to a native WordPress action.
     *
     * @see https://github.com/WordPress/Requests/blob/master/docs/hooks.md
     *
     * @since 4.7.0
     *
     * @param array $parameters Parameters from Requests internal hook.
     * @param array $request Request data in WP_Http format.
     * @param string $url URL to request.
     */
    do_action_ref_array( "requests-{$hook}", $parameters, $this->request, $this->url ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

    return $result;
}

📄 原文内容

Bridge to connect Requests internal hooks to WordPress actions.

Description

Methods

Name	Description
WP_HTTP_Requests_Hooks::__construct	Constructor.
WP_HTTP_Requests_Hooks::dispatch	Dispatch a Requests hook to a native WordPress action.

Source

class WP_HTTP_Requests_Hooks extends WpOrgRequestsHooks {
	/**
	 * Requested URL.
	 *
	 * @var string Requested URL.
	 */
	protected $url;

	/**
	 * WordPress WP_HTTP request data.
	 *
	 * @var array Request data in WP_Http format.
	 */
	protected $request = array();

	/**
	 * Constructor.
	 *
	 * @param string $url     URL to request.
	 * @param array  $request Request data in WP_Http format.
	 */
	public function __construct( $url, $request ) {
		$this->url     = $url;
		$this->request = $request;
	}

	/**
	 * Dispatch a Requests hook to a native WordPress action.
	 *
	 * @param string $hook       Hook name.
	 * @param array  $parameters Parameters to pass to callbacks.
	 * @return bool True if hooks were run, false if nothing was hooked.
	 */
	public function dispatch( $hook, $parameters = array() ) {
		$result = parent::dispatch( $hook, $parameters );

		// Handle back-compat actions.
		switch ( $hook ) {
			case 'curl.before_send':
				/** This action is documented in wp-includes/class-wp-http-curl.php */
				do_action_ref_array( 'http_api_curl', array( &$parameters[0], $this->request, $this->url ) );
				break;
		}

		/**
		 * Transforms a native Request hook to a WordPress action.
		 *
		 * This action maps Requests internal hook to a native WordPress action.
		 *
		 * @see https://github.com/WordPress/Requests/blob/master/docs/hooks.md
		 *
		 * @since 4.7.0
		 *
		 * @param array $parameters Parameters from Requests internal hook.
		 * @param array $request Request data in WP_Http format.
		 * @param string $url URL to request.
		 */
		do_action_ref_array( "requests-{$hook}", $parameters, $this->request, $this->url ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

		return $result;
	}
}

View all references View on Trac View on GitHub

Changelog

Version	Description
4.7.0	Introduced.

云策 WordPress 开发者社区

类文档