pre_http_request WordPress Filter Hook

The pre_http_request hook is an action hook that is called before an HTTP request is made. It is used to modify the HTTP request arguments before the request is sent.

apply_filters( 'pre_http_request', false|array|WP_Error $preempt, array $parsed_args, string $url ) #

Filters the preemptive return value of an HTTP request.


Description

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.


Top ↑

Parameters

$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.


Top ↑

Source

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

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
2.9.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.