2008-08-01 01:00:07 -04:00
|
|
|
<?php
|
|
|
|
/**
|
2008-08-01 14:44:40 -04:00
|
|
|
* Simple and uniform HTTP request API.
|
|
|
|
*
|
|
|
|
* Will eventually replace and standardize the WordPress HTTP requests made.
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
2008-08-05 13:01:49 -04:00
|
|
|
* @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
|
|
|
|
*
|
2008-08-01 01:00:07 -04:00
|
|
|
* @package WordPress
|
|
|
|
* @subpackage HTTP
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the initialized WP_Http Object
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
* @access private
|
|
|
|
*
|
|
|
|
* @return WP_Http HTTP Transport object.
|
|
|
|
*/
|
|
|
|
function &_wp_http_get_object() {
|
|
|
|
static $http;
|
|
|
|
|
2008-08-01 01:45:13 -04:00
|
|
|
if ( is_null($http) )
|
2008-08-01 01:00:07 -04:00
|
|
|
$http = new WP_Http();
|
|
|
|
|
|
|
|
return $http;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve the raw response from the HTTP request.
|
|
|
|
*
|
|
|
|
* The array structure is a little complex.
|
|
|
|
*
|
|
|
|
* <code>
|
2009-02-05 16:59:37 -05:00
|
|
|
* $res = array( 'headers' => array(), 'response' => array('code' => int, 'message' => string) );
|
2008-08-01 01:00:07 -04:00
|
|
|
* </code>
|
|
|
|
*
|
2008-09-07 21:23:43 -04:00
|
|
|
* All of the headers in $res['headers'] are with the name as the key and the
|
|
|
|
* value as the value. So to get the User-Agent, you would do the following.
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* <code>
|
2008-09-07 21:23:43 -04:00
|
|
|
* $user_agent = $res['headers']['user-agent'];
|
2008-08-01 01:00:07 -04:00
|
|
|
* </code>
|
|
|
|
*
|
|
|
|
* The body is the raw response content and can be retrieved from $res['body'].
|
|
|
|
*
|
|
|
|
* This function is called first to make the request and there are other API
|
|
|
|
* functions to abstract out the above convoluted setup.
|
|
|
|
*
|
2008-09-07 21:23:43 -04:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param string $url Site URL to retrieve.
|
|
|
|
* @param array $args Optional. Override the defaults.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return WP_Error|array The response or WP_Error on failure.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
2008-08-12 17:21:11 -04:00
|
|
|
function wp_remote_request($url, $args = array()) {
|
2008-08-01 01:00:07 -04:00
|
|
|
$objFetchSite = _wp_http_get_object();
|
2008-08-12 17:21:11 -04:00
|
|
|
return $objFetchSite->request($url, $args);
|
2008-08-01 01:00:07 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve the raw response from the HTTP request using the GET method.
|
|
|
|
*
|
|
|
|
* @see wp_remote_request() For more information on the response array format.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param string $url Site URL to retrieve.
|
|
|
|
* @param array $args Optional. Override the defaults.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return WP_Error|array The response or WP_Error on failure.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
2008-08-12 17:21:11 -04:00
|
|
|
function wp_remote_get($url, $args = array()) {
|
2008-08-01 01:00:07 -04:00
|
|
|
$objFetchSite = _wp_http_get_object();
|
2008-08-12 17:21:11 -04:00
|
|
|
return $objFetchSite->get($url, $args);
|
2008-08-01 01:00:07 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve the raw response from the HTTP request using the POST method.
|
|
|
|
*
|
|
|
|
* @see wp_remote_request() For more information on the response array format.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param string $url Site URL to retrieve.
|
|
|
|
* @param array $args Optional. Override the defaults.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return WP_Error|array The response or WP_Error on failure.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
2008-08-12 17:21:11 -04:00
|
|
|
function wp_remote_post($url, $args = array()) {
|
2008-08-01 01:00:07 -04:00
|
|
|
$objFetchSite = _wp_http_get_object();
|
2008-08-12 17:21:11 -04:00
|
|
|
return $objFetchSite->post($url, $args);
|
2008-08-01 01:00:07 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve the raw response from the HTTP request using the HEAD method.
|
|
|
|
*
|
|
|
|
* @see wp_remote_request() For more information on the response array format.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param string $url Site URL to retrieve.
|
|
|
|
* @param array $args Optional. Override the defaults.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return WP_Error|array The response or WP_Error on failure.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
2008-08-12 17:21:11 -04:00
|
|
|
function wp_remote_head($url, $args = array()) {
|
2008-08-01 01:00:07 -04:00
|
|
|
$objFetchSite = _wp_http_get_object();
|
2008-08-12 17:21:11 -04:00
|
|
|
return $objFetchSite->head($url, $args);
|
2008-08-01 01:00:07 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve only the headers from the raw response.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param array $response HTTP response.
|
|
|
|
* @return array The headers of the response. Empty array if incorrect parameter given.
|
|
|
|
*/
|
|
|
|
function wp_remote_retrieve_headers(&$response) {
|
2009-04-26 19:54:59 -04:00
|
|
|
if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
|
2008-08-01 01:00:07 -04:00
|
|
|
return array();
|
|
|
|
|
|
|
|
return $response['headers'];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve a single header by name from the raw response.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param array $response
|
|
|
|
* @param string $header Header name to retrieve value from.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return string The header value. Empty string on if incorrect parameter given, or if the header doesnt exist.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
|
|
|
function wp_remote_retrieve_header(&$response, $header) {
|
2009-04-26 19:54:59 -04:00
|
|
|
if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
|
2008-08-01 01:00:07 -04:00
|
|
|
return '';
|
|
|
|
|
2008-08-01 01:45:13 -04:00
|
|
|
if ( array_key_exists($header, $response['headers']) )
|
2008-08-01 01:00:07 -04:00
|
|
|
return $response['headers'][$header];
|
|
|
|
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve only the response code from the raw response.
|
|
|
|
*
|
|
|
|
* Will return an empty array if incorrect parameter value is given.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param array $response HTTP response.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return string the response code. Empty string on incorrect parameter given.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
|
|
|
function wp_remote_retrieve_response_code(&$response) {
|
2009-05-01 19:53:38 -04:00
|
|
|
if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
|
2008-08-01 01:00:07 -04:00
|
|
|
return '';
|
|
|
|
|
|
|
|
return $response['response']['code'];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve only the response message from the raw response.
|
|
|
|
*
|
|
|
|
* Will return an empty array if incorrect parameter value is given.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param array $response HTTP response.
|
2009-04-26 19:54:59 -04:00
|
|
|
* @return string The response message. Empty string on incorrect parameter given.
|
2008-08-01 01:00:07 -04:00
|
|
|
*/
|
|
|
|
function wp_remote_retrieve_response_message(&$response) {
|
2009-04-26 19:54:59 -04:00
|
|
|
if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
|
2008-08-01 01:00:07 -04:00
|
|
|
return '';
|
|
|
|
|
|
|
|
return $response['response']['message'];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve only the body from the raw response.
|
|
|
|
*
|
2008-12-30 17:53:35 -05:00
|
|
|
* @since 2.7.0
|
2008-08-01 01:00:07 -04:00
|
|
|
*
|
|
|
|
* @param array $response HTTP response.
|
|
|
|
* @return string The body of the response. Empty string if no body or incorrect parameter given.
|
|
|
|
*/
|
|
|
|
function wp_remote_retrieve_body(&$response) {
|
2009-04-26 19:54:59 -04:00
|
|
|
if ( is_wp_error($response) || ! isset($response['body']) )
|
2008-08-01 01:00:07 -04:00
|
|
|
return '';
|
|
|
|
|
|
|
|
return $response['body'];
|
|
|
|
}
|
|
|
|
|
2011-05-13 05:56:59 -04:00
|
|
|
/**
|
|
|
|
* Determins if there is an HTTP Transport that can process this request.
|
|
|
|
*
|
|
|
|
* @since 3.2.0
|
|
|
|
*
|
|
|
|
* @param array $capabilities Array of capabilities to test or a wp_remote_request() $args array.
|
|
|
|
* @param string $url Optional. If given, will check if the URL requires SSL and adds that requirement to the capabilities array.
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
function wp_http_supports( $capabilities = array(), $url = null ) {
|
|
|
|
$objFetchSite = _wp_http_get_object();
|
|
|
|
|
|
|
|
$capabilities = wp_parse_args( $capabilities );
|
|
|
|
|
|
|
|
$count = count( $capabilities );
|
|
|
|
|
|
|
|
// If we have a numeric $capabilities array, spoof a wp_remote_request() associative $args array
|
|
|
|
if ( $count && count( array_filter( array_keys( $capabilities ), 'is_numeric' ) ) == $count ) {
|
|
|
|
$capabilities = array_combine( array_values( $capabilities ), array_fill( 0, $count, true ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $url && !isset( $capabilities['ssl'] ) ) {
|
|
|
|
$scheme = parse_url( $url, PHP_URL_SCHEME );
|
|
|
|
if ( 'https' == $scheme || 'ssl' == $scheme ) {
|
|
|
|
$capabilities['ssl'] = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return (bool) $objFetchSite->_get_first_available_transport( $capabilities );
|
|
|
|
}
|