Cleanup doc blocks in http.php.

In the few functions that used `$objFetchSite` instead of `$http`: use the `$http` naming, which is more civilized.

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32599 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor 2015-05-25 17:31:02 +00:00
parent 14706868d2
commit 768115d353

View File

@ -17,6 +17,8 @@
* @since 2.7.0
* @access private
*
* @staticvar WP_Http $http
*
* @return WP_Http HTTP Transport object.
*/
function _wp_http_get_object() {
@ -149,8 +151,8 @@ function wp_safe_remote_head( $url, $args = array() ) {
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_request($url, $args = array()) {
$objFetchSite = _wp_http_get_object();
return $objFetchSite->request($url, $args);
$http = _wp_http_get_object();
return $http->request( $url, $args );
}
/**
@ -166,8 +168,8 @@ function wp_remote_request($url, $args = array()) {
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_get($url, $args = array()) {
$objFetchSite = _wp_http_get_object();
return $objFetchSite->get($url, $args);
$http = _wp_http_get_object();
return $http->get( $url, $args );
}
/**
@ -183,8 +185,8 @@ function wp_remote_get($url, $args = array()) {
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_post($url, $args = array()) {
$objFetchSite = _wp_http_get_object();
return $objFetchSite->post($url, $args);
$http = _wp_http_get_object();
return $http->post( $url, $args );
}
/**
@ -200,8 +202,8 @@ function wp_remote_post($url, $args = array()) {
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_head($url, $args = array()) {
$objFetchSite = _wp_http_get_object();
return $objFetchSite->head($url, $args);
$http = _wp_http_get_object();
return $http->head( $url, $args );
}
/**
@ -293,12 +295,13 @@ function wp_remote_retrieve_body( $response ) {
* @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.
* @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();
$http = _wp_http_get_object();
$capabilities = wp_parse_args( $capabilities );
@ -316,7 +319,7 @@ function wp_http_supports( $capabilities = array(), $url = null ) {
}
}
return (bool) $objFetchSite->_get_first_available_transport( $capabilities );
return (bool) $http->_get_first_available_transport( $capabilities );
}
/**
@ -382,7 +385,7 @@ function get_allowed_http_origins() {
* @since 3.4.0
*
* @param null|string $origin Origin URL. If not provided, the value of get_http_origin() is used.
* @return bool|null True if the origin is allowed. False otherwise.
* @return string True if the origin is allowed. False otherwise.
*/
function is_allowed_http_origin( $origin = null ) {
$origin_arg = $origin;
@ -399,7 +402,7 @@ function is_allowed_http_origin( $origin = null ) {
* @since 3.4.0
*
* @param string $origin Result of check for allowed origin.
* @param string $origin_arg original origin string passed into is_allowed_http_origin function.
* @param string $origin_arg Original origin string passed into is_allowed_http_origin function.
*/
return apply_filters( 'allowed_http_origin', $origin, $origin_arg );
}
@ -414,7 +417,7 @@ function is_allowed_http_origin( $origin = null ) {
*
* @since 3.4.0
*
* @return bool|string Returns the origin URL if headers are sent. Returns false
* @return string|false Returns the origin URL if headers are sent. Returns false
* if headers are not sent.
*/
function send_origin_headers() {
@ -534,6 +537,9 @@ function allowed_http_request_hosts( $is_external, $host ) {
*
* @since 3.6.0
*
* @global wpdb $wpdb
* @staticvar array $queried
*
* @param bool $is_external
* @param string $host
* @return bool