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

Dispatch a Requests hook to a native WordPress action.


Description Description


Parameters Parameters

$hook

(string) (Required) Hook name.

$parameters

(array) (Optional) Parameters to pass to callbacks.

Default value: array()


Top ↑

Return Return

(boolean) True if hooks were run, false if nothing was hooked.


Top ↑

Source Source

File: wp-includes/class-wp-http-requests-hooks.php

	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 actions.
		 *
		 * This action maps Requests internal hook to a native WordPress action.
		 *
		 * @see https://github.com/rmccue/Requests/blob/master/docs/hooks.md
		 *
		 * @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;
	}


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.