WP_HTTP_Requests_Hooks::dispatch( string $hook, array $parameters = array() ): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$hookstring

Hook name.

$parametersarrayoptional

Parameters to pass to callbacks.Default: array()

Return value

bool

True if hooks were run, false if nothing was hooked.

Performance profile

How much work a call to WP_HTTP_Requests_Hooks::dispatch() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

21–31

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 31.

Plugin surface

2 hooks

Third-party callbacks on 'http_api_curl', 'requests-{$hook}' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action_ref_array()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTTP_Requests_Hooks::dispatch() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_HTTP_Requests_Hooks::dispatch() runs, in this order:

1. 1
   do_action( http_api_curl )actionline 58 (+7 into the body)

   Fires before the cURL request is executed.

2. 2
   do_action( requests-{$hook} )actionline 75 (+24 into the body)

   Transforms a native Request hook to a WordPress action.

Uses · 2

• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.
• \WpOrg\Requests\Hooks::dispatch()

Source code

View on Trac ↗View on GitHub ↗

51	public function dispatch( $hook, $parameters = array() ) {52		$result = parent::dispatch( $hook, $parameters );53 54		// Handle back-compat actions.55		switch ( $hook ) {56			case 'curl.before_send':57				/** This action is documented in wp-includes/class-wp-http-curl.php */58				do_action_ref_array( 'http_api_curl', array( &$parameters[0], $this->request, $this->url ) );59				break;60		}61 62		/**63		 * Transforms a native Request hook to a WordPress action.64		 *65		 * This action maps Requests internal hook to a native WordPress action.66		 *67		 * @see https://github.com/WordPress/Requests/blob/master/docs/hooks.md68		 *69		 * @since 4.7.070		 *71		 * @param array $parameters Parameters from Requests internal hook.72		 * @param array $request Request data in WP_Http format.73		 * @param string $url URL to request.74		 */75		do_action_ref_array( "requests-{$hook}", $parameters, $this->request, $this->url ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores76 77		return $result;78	}

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-http-requests-hooks.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.