WP_HTTP_Requests_Hooks WordPress Class
The WP_HTTP_Requests_Hooks class provides an interface for hooking into the WordPress HTTP request lifecycle. It allows you to register callbacks for various events that occur during a request, including before the request is sent, after the request is sent, and when a response is received. This class is useful for performing tasks such as logging HTTP requests, measuring request and response times, or modifying outgoing requests before they are sent.
WP_HTTP_Requests_Hooks #
Bridge to connect Requests internal hooks to WordPress actions.
Description
See also
Source
File: wp-includes/class-wp-http-requests-hooks.php
class WP_HTTP_Requests_Hooks extends Requests_Hooks { /** * 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; } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Methods
- __construct— Constructor.
- dispatch— Dispatch a Requests hook to a native WordPress action.
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |