3 * Core HTTP Request API
5 * Standardizes the HTTP requests for WordPress. Handles cookies, gzip encoding and decoding, chunk
6 * decoding, if HTTP 1.1 and various other difficult HTTP protocol implementations.
13 * Returns the initialized WP_Http Object
18 * @staticvar WP_Http $http
20 * @return WP_Http HTTP Transport object.
22 function _wp_http_get_object() {
25 if ( is_null( $http ) ) {
26 $http = new WP_Http();
32 * Retrieve the raw response from a safe HTTP request.
34 * This function is ideal when the HTTP request is being made to an arbitrary
35 * URL. The URL is validated to avoid redirection and request forgery attacks.
39 * @see wp_remote_request() For more information on the response array format.
40 * @see WP_Http::request() For default arguments information.
42 * @param string $url Site URL to retrieve.
43 * @param array $args Optional. Request arguments. Default empty array.
44 * @return WP_Error|array The response or WP_Error on failure.
46 function wp_safe_remote_request( $url, $args = array() ) {
47 $args['reject_unsafe_urls'] = true;
48 $http = _wp_http_get_object();
49 return $http->request( $url, $args );
53 * Retrieve the raw response from a safe HTTP request using the GET method.
55 * This function is ideal when the HTTP request is being made to an arbitrary
56 * URL. The URL is validated to avoid redirection and request forgery attacks.
60 * @see wp_remote_request() For more information on the response array format.
61 * @see WP_Http::request() For default arguments information.
63 * @param string $url Site URL to retrieve.
64 * @param array $args Optional. Request arguments. Default empty array.
65 * @return WP_Error|array The response or WP_Error on failure.
67 function wp_safe_remote_get( $url, $args = array() ) {
68 $args['reject_unsafe_urls'] = true;
69 $http = _wp_http_get_object();
70 return $http->get( $url, $args );
74 * Retrieve the raw response from a safe HTTP request using the POST method.
76 * This function is ideal when the HTTP request is being made to an arbitrary
77 * URL. The URL is validated to avoid redirection and request forgery attacks.
81 * @see wp_remote_request() For more information on the response array format.
82 * @see WP_Http::request() For default arguments information.
84 * @param string $url Site URL to retrieve.
85 * @param array $args Optional. Request arguments. Default empty array.
86 * @return WP_Error|array The response or WP_Error on failure.
88 function wp_safe_remote_post( $url, $args = array() ) {
89 $args['reject_unsafe_urls'] = true;
90 $http = _wp_http_get_object();
91 return $http->post( $url, $args );
95 * Retrieve the raw response from a safe HTTP request using the HEAD method.
97 * This function is ideal when the HTTP request is being made to an arbitrary
98 * URL. The URL is validated to avoid redirection and request forgery attacks.
102 * @see wp_remote_request() For more information on the response array format.
103 * @see WP_Http::request() For default arguments information.
105 * @param string $url Site URL to retrieve.
106 * @param array $args Optional. Request arguments. Default empty array.
107 * @return WP_Error|array The response or WP_Error on failure.
109 function wp_safe_remote_head( $url, $args = array() ) {
110 $args['reject_unsafe_urls'] = true;
111 $http = _wp_http_get_object();
112 return $http->head( $url, $args );
116 * Retrieve the raw response from the HTTP request.
118 * The array structure is a little complex:
121 * 'headers' => array(),
122 * 'response' => array(
124 * 'message' => string
128 * All of the headers in $res['headers'] are with the name as the key and the
129 * value as the value. So to get the User-Agent, you would do the following.
131 * $user_agent = $res['headers']['user-agent'];
133 * The body is the raw response content and can be retrieved from $res['body'].
135 * This function is called first to make the request and there are other API
136 * functions to abstract out the above convoluted setup.
138 * Request method defaults for helper functions:
139 * - Default 'GET' for wp_remote_get()
140 * - Default 'POST' for wp_remote_post()
141 * - Default 'HEAD' for wp_remote_head()
145 * @see WP_Http::request() For additional information on default arguments.
147 * @param string $url Site URL to retrieve.
148 * @param array $args Optional. Request arguments. Default empty array.
149 * @return WP_Error|array The response or WP_Error on failure.
151 function wp_remote_request($url, $args = array()) {
152 $http = _wp_http_get_object();
153 return $http->request( $url, $args );
157 * Retrieve the raw response from the HTTP request using the GET method.
161 * @see wp_remote_request() For more information on the response array format.
162 * @see WP_Http::request() For default arguments information.
164 * @param string $url Site URL to retrieve.
165 * @param array $args Optional. Request arguments. Default empty array.
166 * @return WP_Error|array The response or WP_Error on failure.
168 function wp_remote_get($url, $args = array()) {
169 $http = _wp_http_get_object();
170 return $http->get( $url, $args );
174 * Retrieve the raw response from the HTTP request using the POST method.
178 * @see wp_remote_request() For more information on the response array format.
179 * @see WP_Http::request() For default arguments information.
181 * @param string $url Site URL to retrieve.
182 * @param array $args Optional. Request arguments. Default empty array.
183 * @return WP_Error|array The response or WP_Error on failure.
185 function wp_remote_post($url, $args = array()) {
186 $http = _wp_http_get_object();
187 return $http->post( $url, $args );
191 * Retrieve the raw response from the HTTP request using the HEAD method.
195 * @see wp_remote_request() For more information on the response array format.
196 * @see WP_Http::request() For default arguments information.
198 * @param string $url Site URL to retrieve.
199 * @param array $args Optional. Request arguments. Default empty array.
200 * @return WP_Error|array The response or WP_Error on failure.
202 function wp_remote_head($url, $args = array()) {
203 $http = _wp_http_get_object();
204 return $http->head( $url, $args );
208 * Retrieve only the headers from the raw response.
212 * @param array $response HTTP response.
213 * @return array The headers of the response. Empty array if incorrect parameter given.
215 function wp_remote_retrieve_headers( $response ) {
216 if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
220 return $response['headers'];
224 * Retrieve a single header by name from the raw response.
228 * @param array $response
229 * @param string $header Header name to retrieve value from.
230 * @return string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.
232 function wp_remote_retrieve_header( $response, $header ) {
233 if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
237 if ( isset( $response['headers'][ $header ] ) ) {
238 return $response['headers'][$header];
245 * Retrieve only the response code from the raw response.
247 * Will return an empty array if incorrect parameter value is given.
251 * @param array $response HTTP response.
252 * @return int|string The response code as an integer. Empty string on incorrect parameter given.
254 function wp_remote_retrieve_response_code( $response ) {
255 if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
258 return $response['response']['code'];
262 * Retrieve only the response message from the raw response.
264 * Will return an empty array if incorrect parameter value is given.
268 * @param array $response HTTP response.
269 * @return string The response message. Empty string on incorrect parameter given.
271 function wp_remote_retrieve_response_message( $response ) {
272 if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
275 return $response['response']['message'];
279 * Retrieve only the body from the raw response.
283 * @param array $response HTTP response.
284 * @return string The body of the response. Empty string if no body or incorrect parameter given.
286 function wp_remote_retrieve_body( $response ) {
287 if ( is_wp_error($response) || ! isset($response['body']) )
290 return $response['body'];
294 * Retrieve only the cookies from the raw response.
298 * @param array $response HTTP response.
299 * @return array An array of `WP_Http_Cookie` objects from the response. Empty array if there are none, or the response is a WP_Error.
301 function wp_remote_retrieve_cookies( $response ) {
302 if ( is_wp_error( $response ) || empty( $response['cookies'] ) ) {
306 return $response['cookies'];
310 * Retrieve a single cookie by name from the raw response.
314 * @param array $response HTTP response.
315 * @param string $name The name of the cookie to retrieve.
316 * @return WP_Http_Cookie|string The `WP_Http_Cookie` object. Empty string if the cookie isn't present in the response.
318 function wp_remote_retrieve_cookie( $response, $name ) {
319 $cookies = wp_remote_retrieve_cookies( $response );
321 if ( empty( $cookies ) ) {
325 foreach ( $cookies as $cookie ) {
326 if ( $cookie->name === $name ) {
335 * Retrieve a single cookie's value by name from the raw response.
339 * @param array $response HTTP response.
340 * @param string $name The name of the cookie to retrieve.
341 * @return string The value of the cookie. Empty string if the cookie isn't present in the response.
343 function wp_remote_retrieve_cookie_value( $response, $name ) {
344 $cookie = wp_remote_retrieve_cookie( $response, $name );
346 if ( ! is_a( $cookie, 'WP_Http_Cookie' ) ) {
350 return $cookie->value;
354 * Determines if there is an HTTP Transport that can process this request.
358 * @param array $capabilities Array of capabilities to test or a wp_remote_request() $args array.
359 * @param string $url Optional. If given, will check if the URL requires SSL and adds
360 * that requirement to the capabilities array.
364 function wp_http_supports( $capabilities = array(), $url = null ) {
365 $http = _wp_http_get_object();
367 $capabilities = wp_parse_args( $capabilities );
369 $count = count( $capabilities );
371 // If we have a numeric $capabilities array, spoof a wp_remote_request() associative $args array
372 if ( $count && count( array_filter( array_keys( $capabilities ), 'is_numeric' ) ) == $count ) {
373 $capabilities = array_combine( array_values( $capabilities ), array_fill( 0, $count, true ) );
376 if ( $url && !isset( $capabilities['ssl'] ) ) {
377 $scheme = parse_url( $url, PHP_URL_SCHEME );
378 if ( 'https' == $scheme || 'ssl' == $scheme ) {
379 $capabilities['ssl'] = true;
383 return (bool) $http->_get_first_available_transport( $capabilities );
387 * Get the HTTP Origin of the current request.
391 * @return string URL of the origin. Empty string if no origin.
393 function get_http_origin() {
395 if ( ! empty ( $_SERVER[ 'HTTP_ORIGIN' ] ) )
396 $origin = $_SERVER[ 'HTTP_ORIGIN' ];
399 * Change the origin of an HTTP request.
403 * @param string $origin The original origin for the request.
405 return apply_filters( 'http_origin', $origin );
409 * Retrieve list of allowed HTTP origins.
413 * @return array Array of origin URLs.
415 function get_allowed_http_origins() {
416 $admin_origin = parse_url( admin_url() );
417 $home_origin = parse_url( home_url() );
419 // @todo preserve port?
420 $allowed_origins = array_unique( array(
421 'http://' . $admin_origin[ 'host' ],
422 'https://' . $admin_origin[ 'host' ],
423 'http://' . $home_origin[ 'host' ],
424 'https://' . $home_origin[ 'host' ],
428 * Change the origin types allowed for HTTP requests.
432 * @param array $allowed_origins {
433 * Default allowed HTTP origins.
434 * @type string Non-secure URL for admin origin.
435 * @type string Secure URL for admin origin.
436 * @type string Non-secure URL for home origin.
437 * @type string Secure URL for home origin.
440 return apply_filters( 'allowed_http_origins' , $allowed_origins );
444 * Determines if the HTTP origin is an authorized one.
448 * @param null|string $origin Origin URL. If not provided, the value of get_http_origin() is used.
449 * @return string Origin URL if allowed, empty string if not.
451 function is_allowed_http_origin( $origin = null ) {
452 $origin_arg = $origin;
454 if ( null === $origin )
455 $origin = get_http_origin();
457 if ( $origin && ! in_array( $origin, get_allowed_http_origins() ) )
461 * Change the allowed HTTP origin result.
465 * @param string $origin Origin URL if allowed, empty string if not.
466 * @param string $origin_arg Original origin string passed into is_allowed_http_origin function.
468 return apply_filters( 'allowed_http_origin', $origin, $origin_arg );
472 * Send Access-Control-Allow-Origin and related headers if the current request
473 * is from an allowed origin.
475 * If the request is an OPTIONS request, the script exits with either access
476 * control headers sent, or a 403 response if the origin is not allowed. For
477 * other request methods, you will receive a return value.
481 * @return string|false Returns the origin URL if headers are sent. Returns false
482 * if headers are not sent.
484 function send_origin_headers() {
485 $origin = get_http_origin();
487 if ( is_allowed_http_origin( $origin ) ) {
488 @header( 'Access-Control-Allow-Origin: ' . $origin );
489 @header( 'Access-Control-Allow-Credentials: true' );
490 if ( 'OPTIONS' === $_SERVER['REQUEST_METHOD'] )
495 if ( 'OPTIONS' === $_SERVER['REQUEST_METHOD'] ) {
496 status_header( 403 );
504 * Validate a URL for safe use in the HTTP API.
509 * @return false|string URL or false on failure.
511 function wp_http_validate_url( $url ) {
512 $original_url = $url;
513 $url = wp_kses_bad_protocol( $url, array( 'http', 'https' ) );
514 if ( ! $url || strtolower( $url ) !== strtolower( $original_url ) )
517 $parsed_url = @parse_url( $url );
518 if ( ! $parsed_url || empty( $parsed_url['host'] ) )
521 if ( isset( $parsed_url['user'] ) || isset( $parsed_url['pass'] ) )
524 if ( false !== strpbrk( $parsed_url['host'], ':#?[]' ) )
527 $parsed_home = @parse_url( get_option( 'home' ) );
529 if ( isset( $parsed_home['host'] ) ) {
530 $same_host = ( strtolower( $parsed_home['host'] ) === strtolower( $parsed_url['host'] ) || 'localhost' === strtolower( $parsed_url['host'] ) );
535 if ( ! $same_host ) {
536 $host = trim( $parsed_url['host'], '.' );
537 if ( preg_match( '#^(([1-9]?\d|1\d\d|25[0-5]|2[0-4]\d)\.){3}([1-9]?\d|1\d\d|25[0-5]|2[0-4]\d)$#', $host ) ) {
540 $ip = gethostbyname( $host );
541 if ( $ip === $host ) // Error condition for gethostbyname()
545 $parts = array_map( 'intval', explode( '.', $ip ) );
546 if ( 127 === $parts[0] || 10 === $parts[0] || 0 === $parts[0]
547 || ( 172 === $parts[0] && 16 <= $parts[1] && 31 >= $parts[1] )
548 || ( 192 === $parts[0] && 168 === $parts[1] )
550 // If host appears local, reject unless specifically allowed.
552 * Check if HTTP request is external or not.
554 * Allows to change and allow external requests for the HTTP request.
558 * @param bool false Whether HTTP request is external or not.
559 * @param string $host IP of the requested host.
560 * @param string $url URL of the requested host.
562 if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) )
568 if ( empty( $parsed_url['port'] ) )
571 $port = $parsed_url['port'];
572 if ( 80 === $port || 443 === $port || 8080 === $port )
575 if ( $parsed_home && $same_host && isset( $parsed_home['port'] ) && $parsed_home['port'] === $port )
582 * Whitelists allowed redirect hosts for safe HTTP requests as well.
584 * Attached to the {@see 'http_request_host_is_external'} filter.
588 * @param bool $is_external
589 * @param string $host
592 function allowed_http_request_hosts( $is_external, $host ) {
593 if ( ! $is_external && wp_validate_redirect( 'http://' . $host ) )
599 * Whitelists any domain in a multisite installation for safe HTTP requests.
601 * Attached to the {@see 'http_request_host_is_external'} filter.
605 * @global wpdb $wpdb WordPress database abstraction object.
606 * @staticvar array $queried
608 * @param bool $is_external
609 * @param string $host
612 function ms_allowed_http_request_hosts( $is_external, $host ) {
614 static $queried = array();
617 if ( $host === get_current_site()->domain )
619 if ( isset( $queried[ $host ] ) )
620 return $queried[ $host ];
621 $queried[ $host ] = (bool) $wpdb->get_var( $wpdb->prepare( "SELECT domain FROM $wpdb->blogs WHERE domain = %s LIMIT 1", $host ) );
622 return $queried[ $host ];
626 * A wrapper for PHP's parse_url() function that handles edgecases in < PHP 5.4.7
628 * PHP 5.4.7 expanded parse_url()'s ability to handle non-absolute url's, including
629 * schemeless and relative url's with :// in the path, this works around those
630 * limitations providing a standard output on PHP 5.2~5.4+.
632 * Error suppression is used as prior to PHP 5.3.3, an E_WARNING would be generated
633 * when URL parsing failed.
637 * @param string $url The URL to parse.
638 * @return bool|array False on failure; Array of URL components on success;
639 * See parse_url()'s return values.
641 function wp_parse_url( $url ) {
642 $parts = @parse_url( $url );
644 // < PHP 5.4.7 compat, trouble with relative paths including a scheme break in the path
645 if ( '/' == $url[0] && false !== strpos( $url, '://' ) ) {
646 // Since we know it's a relative path, prefix with a scheme/host placeholder and try again
647 if ( ! $parts = @parse_url( 'placeholder://placeholder' . $url ) ) {
650 // Remove the placeholder values
651 unset( $parts['scheme'], $parts['host'] );
657 // < PHP 5.4.7 compat, doesn't detect schemeless URL's host field
658 if ( '//' == substr( $url, 0, 2 ) && ! isset( $parts['host'] ) ) {
659 $path_parts = explode( '/', substr( $parts['path'], 2 ), 2 );
660 $parts['host'] = $path_parts[0];
661 if ( isset( $path_parts[1] ) ) {
662 $parts['path'] = '/' . $path_parts[1];
664 unset( $parts['path'] );