Make WordPress Core

Ticket #26049: 26049.patch

File 26049.patch, 10.1 KB (added by DrewAPicture, 11 years ago)

2nd pass

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

     
    6969
    7070                $defaults = array(
    7171                        'method' => 'GET',
    72                         'timeout' => apply_filters( 'http_request_timeout', 5),
    73                         'redirection' => apply_filters( 'http_request_redirection_count', 5),
    74                         'httpversion' => apply_filters( 'http_request_version', '1.0'),
     72                        /**
     73                         * Filter the timeout value for an HTTP request.
     74                         *
     75                         * @since 2.7.0
     76                         *
     77                         * @param int $timeout_value Time in seconds until a request times out.
     78                         *                           Default 5.
     79                         */
     80                        'timeout' => apply_filters( 'http_request_timeout', 5 ),
     81                        /**
     82                         * Filter the number of redirects allowed during an HTTP request.
     83                         *
     84                         * @since 2.7.0
     85                         *
     86                         * @param int $redirect_count Number of redirects allowed. Default 5.
     87                         */
     88                        'redirection' => apply_filters( 'http_request_redirection_count', 5 ),
     89                        /**
     90                         * Filter the version of the HTTP protocol used in a request.
     91                         *
     92                         * @since 2.7.0
     93                         *
     94                         * @param string $version Version of HTTP used. Accepts '1.0' and '1.1'.
     95                         *                        Default '1.0'.
     96                         */
     97                        'httpversion' => apply_filters( 'http_request_version', '1.0' ),
     98                        /**
     99                         * Filter the user agent value sent with an HTTP request.
     100                         *
     101                         * @since 2.7.0
     102                         *
     103                         * @param string $user_agent WordPress user agent string.
     104                         */
    75105                        'user-agent' => apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) ),
     106                        /**
     107                         * Filter whether to pass URLs through wp_http_validate_url() in an HTTP request.
     108                         *
     109                         * @since 3.6.0
     110                         *
     111                         * @param bool $bool Whether to pass URLs through wp_http_validate_url(). Default false.
     112                         */
    76113                        'reject_unsafe_urls' => apply_filters( 'http_request_reject_unsafe_urls', false ),
    77114                        'blocking' => true,
    78115                        'headers' => array(),
     
    95132                        $defaults['redirection'] = 0;
    96133
    97134                $r = wp_parse_args( $args, $defaults );
     135                /**
     136                 * Filter the arguments used in an HTTP request.
     137                 *
     138                 * @since 2.7.0
     139                 *
     140                 * @param array  $r   An array of HTTP request arguments.
     141                 * @param string $url The request URI resource.
     142                 */
    98143                $r = apply_filters( 'http_request_args', $r, $url );
    99144
    100145                // The transports decrement this, store a copy of the original value for loop purposes.
    101146                if ( ! isset( $r['_redirection'] ) )
    102147                        $r['_redirection'] = $r['redirection'];
    103148
    104                 // Allow plugins to short-circuit the request
     149                /**
     150                 * Filter whether to preempt an HTTP request return.
     151                 *
     152                 * Returning a truthy value to the filter will short-circuit
     153                 * the HTTP request and return early with that value.
     154                 *
     155                 * @since 2.9.0
     156                 *
     157                 * @param bool   $bool whether to preempt an HTTP request return. Default false.
     158                 * @param array  $r    HTTP request arguments.
     159                 * @param string $url  The request URI resource.
     160                 */
    105161                $pre = apply_filters( 'pre_http_request', false, $r, $url );
    106162                if ( false !== $pre )
    107163                        return $pre;
     
    221277         * @return string|bool Class name for the first transport that claims to support the request. False if no transport claims to support the request.
    222278         */
    223279        public function _get_first_available_transport( $args, $url = null ) {
     280                /**
     281                 * Filter which HTTP transports are available and in what order.
     282                 *
     283                 * @since 3.7.0
     284                 *
     285                 * @param array  $value Array of HTTP transports to check. Default array contains
     286                 *                      'curl', and 'streams', in that order.
     287                 * @param array  $args  HTTP request arguments.
     288                 * @param string $url   The URL to request.
     289                 */
    224290                $request_order = apply_filters( 'http_api_transports', array( 'curl', 'streams' ), $args, $url );
    225291
    226292                // Loop over each transport on each HTTP request looking for one which will serve this request's needs
     
    265331
    266332                $response = $transports[$class]->request( $url, $args );
    267333
     334                /**
     335                 * Fires after an HTTP API response is received and before the response is returned.
     336                 *
     337                 * @since 2.8.0
     338                 *
     339                 * @param mixed  $response HTTP Response or WP_Error object.
     340                 * @param string $context  Context under which the hook is fired.
     341                 * @param string $class    HTTP transport used.
     342                 * @param array  $args     HTTP request arguments.
     343                 * @param string $url      The request URL.
     344                 */
    268345                do_action( 'http_api_debug', $response, 'response', $class, $args, $url );
    269346
    270347                if ( is_wp_error( $response ) )
    271348                        return $response;
    272349
     350                /**
     351                 * Filter the HTTP API response immediately before the response is returned.
     352                 *
     353                 * @since 2.9.0
     354                 *
     355                 * @param array|object $response HTTP Response.
     356                 * @param array        $args     HTTP request arguments.
     357                 * @param string       $url      The request URL.
     358                 */
    273359                return apply_filters( 'http_response', $response, $args, $url );
    274360        }
    275361
     
    516602                $home = parse_url( get_option('siteurl') );
    517603
    518604                // Don't block requests back to ourselves by default
    519                 if ( $check['host'] == 'localhost' || $check['host'] == $home['host'] )
    520                         return apply_filters('block_local_requests', false);
     605                if ( $check['host'] == 'localhost' || $check['host'] == $home['host'] ) {
     606                        /**
     607                         * Filter whether to block local requests through the proxy.
     608                         *
     609                         * @since 2.8.0
     610                         *
     611                         * @param bool $block Whether to block local requests through proxy.
     612                         *                    Default false.
     613                         */
     614                        return apply_filters( 'block_local_requests', false );
     615                }
    521616
    522617                if ( !defined('WP_ACCESSIBLE_HOSTS') )
    523618                        return true;
     
    742837
    743838                $is_local = isset( $r['local'] ) && $r['local'];
    744839                $ssl_verify = isset( $r['sslverify'] ) && $r['sslverify'];
    745                 if ( $is_local )
     840                if ( $is_local ) {
     841                        /**
     842                         * Filter whether SSL should be verified for local requests.
     843                         *
     844                         * @since 2.8.0
     845                         *
     846                         * @param bool $ssl_verify Whether to verify the SSL connection. Default true.
     847                         */
    746848                        $ssl_verify = apply_filters( 'https_local_ssl_verify', $ssl_verify );
    747                 elseif ( ! $is_local )
     849                } elseif ( ! $is_local ) {
     850                        /**
     851                         * Filter whether SSL should be verified for non-local requests.
     852                         *
     853                         * @since 2.8.0
     854                         *
     855                         * @param bool $ssl_verify Whether to verify the SSL connection. Default true
     856                         */
    748857                        $ssl_verify = apply_filters( 'https_ssl_verify', $ssl_verify );
     858                }
    749859
    750860                $proxy = new WP_HTTP_Proxy();
    751861
     
    10261136                                return false;
    10271137                }
    10281138
     1139                /**
     1140                 * Filter whether the WP_Http_Streams class can be used as a transport
     1141                 * for retrieving a URL.
     1142                 *
     1143                 * @since 2.7.0
     1144                 *
     1145                 * @param bool  $bool Whether the class can be used. Default true.
     1146                 * @param array $args Request arguments.
     1147                 */
    10291148                return apply_filters( 'use_streams_transport', true, $args );
    10301149        }
    10311150}
     
    11451264
    11461265                $is_local = isset($r['local']) && $r['local'];
    11471266                $ssl_verify = isset($r['sslverify']) && $r['sslverify'];
    1148                 if ( $is_local )
    1149                         $ssl_verify = apply_filters('https_local_ssl_verify', $ssl_verify);
    1150                 elseif ( ! $is_local )
    1151                         $ssl_verify = apply_filters('https_ssl_verify', $ssl_verify);
     1267                if ( $is_local ) {
     1268                        /** This filter is documented in wp-includes/class-http.php */
     1269                        $ssl_verify = apply_filters( 'https_local_ssl_verify', $ssl_verify );
     1270                } elseif ( ! $is_local ) {
     1271                        /** This filter is documented in wp-includes/class-http.php */
     1272                        $ssl_verify = apply_filters( 'https_ssl_verify', $ssl_verify );
     1273                }
    11521274
    11531275                // CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since
    11541276                // a value of 0 will allow an unlimited timeout.
     
    12251347                else
    12261348                        curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1 );
    12271349
    1228                 // Cookies are not handled by the HTTP API currently. Allow for plugin authors to handle it
    1229                 // themselves... Although, it is somewhat pointless without some reference.
     1350                /**
     1351                 * Fires before the cURL process is executed.
     1352                 *
     1353                 * Cookies are not currently handled by the HTTP API. This action allows
     1354                 * plugins to handle cookies themselves.
     1355                 *
     1356                 * @since 2.8.0
     1357                 *
     1358                 * @param array $handle cURL options set using curl_setopt().
     1359                 */
    12301360                do_action_ref_array( 'http_api_curl', array(&$handle) );
    12311361
    12321362                // We don't need to return the body, so don't. Just execute request and return.
     
    13611491                                return false;
    13621492                }
    13631493
     1494                /**
     1495                 * Filter whether the WP_Http_Curl class can be used as a transport
     1496                 * for retrieving a URL.
     1497                 *
     1498                 * @since 2.7.0
     1499                 *
     1500                 * @param bool  $bool Whether the class can be used. Default true.
     1501                 * @param array $args An array of request arguments.
     1502                 */
    13641503                return apply_filters( 'use_curl_transport', true, $args );
    13651504        }
    13661505}
     
    15291668
    15301669                $home = parse_url( get_option('siteurl') );
    15311670
     1671                /**
     1672                 * Filter whether to preempt sending the request through the proxy server.
     1673                 *
     1674                 * Returning a false value will bypass the proxy, returning true will send
     1675                 * the request through the proxy.
     1676                 *
     1677                 * @since 3.5.0
     1678                 *
     1679                 * @param null   $override Whether to override the request result. Default null.
     1680                 * @param string $uri      URL to check.
     1681                 * @param array  $check    Associative array result of parsing the URI.
     1682                 * @param array  $home     Associative array result of parsing the site URL.
     1683                 */
    15321684                $result = apply_filters( 'pre_http_send_through_proxy', null, $uri, $check, $home );
    15331685                if ( ! is_null( $result ) )
    15341686                        return $result;
     
    17431895                if ( ! isset( $this->name ) || ! isset( $this->value ) )
    17441896                        return '';
    17451897
     1898                /**
     1899                 * Filter the header-encoded cookie value.
     1900                 *
     1901                 * @since 3.4.0
     1902                 *
     1903                 * @param string $value The cookie value.
     1904                 * @param string $name  The cookie name.
     1905                 */
    17461906                return $this->name . '=' . apply_filters( 'wp_http_cookie_value', $this->value, $this->name );
    17471907        }
    17481908
     
    19042064                                $type[] = 'gzip;q=0.5';
    19052065                }
    19062066
     2067                /**
     2068                 * Filter the allowed encoding types.
     2069                 *
     2070                 * @since 3.6.0
     2071                 *
     2072                 * @param array  $type Encoding types allowed. Accepts 'gzinflate',
     2073                 *                     'gzuncompress', 'gzdecode'.
     2074                 * @param string $url  URL of the HTTP request.
     2075                 * @param array  $args HTTP request arguments.
     2076                 */
    19072077                $type = apply_filters( 'wp_http_accept_encoding', $type, $url, $args );
    19082078
    19092079                return implode(', ', $type);