mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-23 01:27:36 +01:00
Docs: Improve the summary and description for the pre_http_request
filter docs to better illustrate expected values.
The filter explicitly expects one of three passed value types: * An array containing 'headers', 'body', 'response', 'cookies', and 'filename' elements * A `WP_Error` instance * Boolean false (to avoid short-circuiting the response) Props johnbillion. Fixes #33995. Built from https://develop.svn.wordpress.org/trunk@34509 git-svn-id: http://core.svn.wordpress.org/trunk@34473 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
6fdd384fe0
commit
4c7a4bfb25
@ -159,18 +159,25 @@ class WP_Http {
|
||||
$r['_redirection'] = $r['redirection'];
|
||||
|
||||
/**
|
||||
* Filter whether to preempt an HTTP request's return.
|
||||
* Filter whether to preempt an HTTP request's return value.
|
||||
*
|
||||
* Returning a truthy value to the filter will short-circuit
|
||||
* the HTTP request and return early with that value.
|
||||
* Returning a non-false value from the filter will short-circuit the HTTP request and return
|
||||
* early with that value. A filter should return either:
|
||||
*
|
||||
* - 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.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param bool $preempt Whether to preempt an HTTP request return. Default false.
|
||||
* @param array $r HTTP request arguments.
|
||||
* @param string $url The request URL.
|
||||
* @param false|array|WP_Error $preempt Whether to preempt an HTTP request's return value. Default false.
|
||||
* @param array $r HTTP request arguments.
|
||||
* @param string $url The request URL.
|
||||
*/
|
||||
$pre = apply_filters( 'pre_http_request', false, $r, $url );
|
||||
|
||||
if ( false !== $pre )
|
||||
return $pre;
|
||||
|
||||
|
@ -4,7 +4,7 @@
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.4-alpha-34508';
|
||||
$wp_version = '4.4-alpha-34509';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
Loading…
Reference in New Issue
Block a user