Changeset 46424 for trunk/src/wp-includes/class-http.php

Timestamp:

10/07/2019 07:06:41 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous inline docs corrections and improvements.

See #47110

File:

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

trunk/src/wp-includes/class-http.php

@@ -134 +134 @@
      *                                             need to be separately decompressed. Default true.
      *     @type bool         $sslverify           Whether to verify SSL for the request. Default true.
-     *     @type string       sslcertificates      Absolute path to an SSL certificate .crt file.
+     *     @type string       $sslcertificates     Absolute path to an SSL certificate .crt file.
      *                                             Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'.
      *     @type bool         $stream              Whether to stream to a file. If set to true and no filename was
@@ -216 +216 @@
         $args = wp_parse_args( $args );
 
-        // By default, Head requests do not cause redirections.
+        // By default, HEAD requests do not cause redirections.
         if ( isset( $args['method'] ) && 'HEAD' == $args['method'] ) {
             $defaults['redirection'] = 0;
@@ -251 +251 @@
          * @since 2.9.0
          *
-         * @param false|array|WP_Error $preempt Whether to preempt an HTTP request's return value. Default false.
-         * @param array                $parsed_args        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                $parsed_args HTTP request arguments.
+         * @param string               $url         The request URL.
          */
         $pre = apply_filters( 'pre_http_request', false, $parsed_args, $url );
@@ -410 +410 @@
          * @since 2.8.0
          *
-         * @param array|WP_Error $response HTTP response or WP_Error object.
-         * @param string         $context  Context under which the hook is fired.
-         * @param string         $class    HTTP transport used.
-         * @param array          $parsed_args        HTTP request arguments.
-         * @param string         $url      The request URL.
+         * @param array|WP_Error $response    HTTP response or WP_Error object.
+         * @param string         $context     Context under which the hook is fired.
+         * @param string         $class       HTTP transport used.
+         * @param array          $parsed_args HTTP request arguments.
+         * @param string         $url         The request URL.
          */
         do_action( 'http_api_debug', $response, 'response', 'Requests', $parsed_args, $url );
@@ -439 +439 @@
          * @since 2.9.0
          *
-         * @param array  $response HTTP response.
-         * @param array  $parsed_args        HTTP request arguments.
-         * @param string $url      The request URL.
+         * @param array  $response    HTTP response.
+         * @param array  $parsed_args HTTP request arguments.
+         * @param string $url         The request URL.
          */
         return apply_filters( 'http_response', $response, $parsed_args, $url );
@@ -891 +891 @@
             return ! preg_match( $wildcard_regex, $check['host'] );
         } else {
-            return ! in_array( $check['host'], $accessible_hosts ); //Inverse logic, If it's in the array, then we can't access it.
+            return ! in_array( $check['host'], $accessible_hosts ); // Inverse logic, if it's in the array, then don't block it.
         }
 
@@ -990 +990 @@
 
     /**
-     * Handles HTTP Redirects and follows them if appropriate.
+     * Handles an HTTP redirect and follows it if appropriate.
      *
      * @since 3.7.0