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

Timestamp:

09/21/2019 05:40:58 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Docblock corrections and improvements, mostly related to various pre_* filters.

See #47110

File:

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

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

@@ -153 +153 @@
 
     /**
-     * Whether URL should be sent through the proxy server.
-     *
-     * We want to keep localhost and the site URL from being sent through the proxy server, because
+     * Determines whether the request should be sent through a proxy.
+     *
+     * We want to keep localhost and the site URL from being sent through the proxy, because
      * some proxies can not handle this. We also have the constant available for defining other
      * hosts that won't be sent through the proxy.
@@ -182 +182 @@
 
         /**
-         * Filters whether to preempt sending the request through the proxy server.
+         * Filters whether to preempt sending the request through the proxy.
          *
          * Returning false will bypass the proxy; returning true will send
@@ -189 +189 @@
          * @since 3.5.0
          *
-         * @param null   $override Whether to override the request result. Default null.
-         * @param string $uri      URL to check.
-         * @param array  $check    Associative array result of parsing the URI.
-         * @param array  $home     Associative array result of parsing the site URL.
+         * @param bool|null $override Whether to override the request result. Default null.
+         * @param string    $uri      URL to check.
+         * @param array     $check    Associative array result of parsing the request URI.
+         * @param array     $home     Associative array result of parsing the site URL.
          */
         $result = apply_filters( 'pre_http_send_through_proxy', null, $uri, $check, $home );