pre_http_request filter-hookWP 2.9.0

Filters the preemptive return value of an HTTP request.

Returning a non-false value from the filter will short-circuit the HTTP request and return early with that value. A filter should return one of:

  • An array containing 'headers', 'body', 'response', 'cookies', and 'filename' elements
  • A WP_Error instance
  • boolean false to avoid short-circuiting the response

Returning any other value may result in unexpected behaviour.

Usage

add_filter( 'pre_http_request', 'wp_kama_pre_http_request_filter', 10, 3 );

/**
 * Function for `pre_http_request` filter-hook.
 * 
 * @param false|array|WP_Error $preempt     A preemptive return value of an HTTP request.
 * @param array                $parsed_args HTTP request arguments.
 * @param string               $url         The request URL.
 *
 * @return false|array|WP_Error
 */
function wp_kama_pre_http_request_filter( $preempt, $parsed_args, $url ){

	// filter...
	return $preempt;
}
$preempt(false|array|WP_Error)
A preemptive return value of an HTTP request.
Default: false
$parsed_args(array)
HTTP request arguments.
$url(string)
The request URL.

Changelog

Since 2.9.0 Introduced.

Where the hook is called

WP_Http::request()
pre_http_request
wp-includes/class-wp-http.php 257
$pre = apply_filters( 'pre_http_request', false, $parsed_args, $url );

Where the hook is used in WordPress

Usage not found.