Changeset 32599

Timestamp:

05/25/2015 05:31:02 PM (9 years ago)

Author:

wonderboymusic

Message:

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.

File:

• trunk/src/wp-includes/http.php (modified) (14 diffs)

trunk/src/wp-includes/http.php

@@ -17 +17 @@
  * @since 2.7.0
  * @access private
+ *
+ * @staticvar WP_Http $http
  *
  * @return WP_Http HTTP Transport object.
@@ -150 +152 @@
  */
 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 );
 }
 
@@ -167 +169 @@
  */
 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 );
 }
 
@@ -184 +186 @@
  */
 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 );
 }
 
@@ -201 +203 @@
  */
 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 );
 }
 
@@ -225 +227 @@
  * @since 2.7.0
  *
- * @param array $response
+ * @param array  $response
  * @param string $header Header name to retrieve value from.
  * @return string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.
@@ -294 +296 @@
  *
  * @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 );
@@ -317 +320 @@
     }
 
-    return (bool) $objFetchSite->_get_first_available_transport( $capabilities );
+    return (bool) $http->_get_first_available_transport( $capabilities );
 }
 
@@ -383 +386 @@
  *
  * @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 ) {
@@ -399 +402 @@
      * @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     Result of check for allowed origin.
+     * @param string $origin_arg Original origin string passed into is_allowed_http_origin function.
      */
     return apply_filters( 'allowed_http_origin', $origin, $origin_arg );
@@ -415 +418 @@
  * @since 3.4.0
  *
- * @return bool|string Returns the origin URL if headers are sent. Returns false
- * if headers are not sent.
+ * @return string|false Returns the origin URL if headers are sent. Returns false
+ *                      if headers are not sent.
  */
 function send_origin_headers() {
@@ -488 +491 @@
                  * @since 3.6.0
                  *
-                 * @param bool false Whether HTTP request is external or not.
+                 * @param bool   false Whether HTTP request is external or not.
                  * @param string $host IP of the requested host.
-                 * @param string $url URL of the requested host.
+                 * @param string $url  URL of the requested host.
                  */
                 if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) )
@@ -518 +521 @@
  * @since 3.6.0
  *
- * @param bool $is_external
+ * @param bool   $is_external
  * @param string $host
  * @return bool
@@ -535 +538 @@
  * @since 3.6.0
  *
- * @param bool $is_external
+ * @global wpdb $wpdb
+ * @staticvar array $queried
+ *
+ * @param bool   $is_external
  * @param string $host
  * @return bool