enmi-conf.org: comparison wp/wp-includes/http.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 * Returns the initialized WP_Http Object
 *
 * @since 2.7.0
 * @access private
 *
-* @staticvar WP_Http $http
-*
 * @return WP_Http HTTP Transport object.
 */
 function _wp_http_get_object() {
 	static $http = null;
 * @since 3.6.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_safe_remote_request( $url, $args = array() ) {
 	$args['reject_unsafe_urls'] = true;
 	$http                       = _wp_http_get_object();
 	return $http->request( $url, $args );
 * @since 3.6.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_safe_remote_get( $url, $args = array() ) {
 	$args['reject_unsafe_urls'] = true;
 	$http                       = _wp_http_get_object();
 	return $http->get( $url, $args );
 * @since 3.6.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_safe_remote_post( $url, $args = array() ) {
 	$args['reject_unsafe_urls'] = true;
 	$http                       = _wp_http_get_object();
 	return $http->post( $url, $args );
 * @since 3.6.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url Site URL to retrieve.
+* @param string $url  URL to retrieve.
-* @param array $args Optional. Request arguments. Default empty array.
+* @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_safe_remote_head( $url, $args = array() ) {
 	$args['reject_unsafe_urls'] = true;
 	$http                       = _wp_http_get_object();
 	return $http->head( $url, $args );
 }
 /**
-* Retrieve the raw response from the HTTP request.
+* Performs an HTTP request and returns its response.
 *
-* The array structure is a little complex:
+* There are other API functions available which abstract away the HTTP method:
 *
-*     $res = array(
-*         'headers'  => array(),
-*         'response' => array(
-*             'code'    => int,
-*             'message' => string
-*         )
-*     );
-*
-* All of the headers in $res['headers'] are with the name as the key and the
-* value as the value. So to get the User-Agent, you would do the following.
-*
-*     $user_agent = $res['headers']['user-agent'];
-*
-* The body is the raw response content and can be retrieved from $res['body'].
-*
-* This function is called first to make the request and there are other API
-* functions to abstract out the above convoluted setup.
-*
-* Request method defaults for helper functions:
 *  - Default 'GET'  for wp_remote_get()
 *  - Default 'POST' for wp_remote_post()
 *  - Default 'HEAD' for wp_remote_head()
 *
 * @since 2.7.0
 *
-* @see WP_Http::request() For additional information on default arguments.
+* @see WP_Http::request() For information on default arguments.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error {
+*     The response array or a WP_Error on failure.
+*
+*     @type string[]                       $headers       Array of response headers keyed by their name.
+*     @type string                         $body          Response body.
+*     @type array                          $response      {
+*         Data about the HTTP response.
+*
+*         @type int|false    $code    HTTP response code.
+*         @type string|false $message HTTP response message.
+*     }
+*     @type WP_HTTP_Cookie[]               $cookies       Array of response cookies.
+*     @type WP_HTTP_Requests_Response|null $http_response Raw HTTP response object.
+* }
 */
 function wp_remote_request( $url, $args = array() ) {
 	$http = _wp_http_get_object();
 	return $http->request( $url, $args );
 }
 /**
-* Retrieve the raw response from the HTTP request using the GET method.
+* Performs an HTTP request using the GET method and returns its response.
 *
 * @since 2.7.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_remote_get( $url, $args = array() ) {
 	$http = _wp_http_get_object();
 	return $http->get( $url, $args );
 }
 /**
-* Retrieve the raw response from the HTTP request using the POST method.
+* Performs an HTTP request using the POST method and returns its response.
 *
 * @since 2.7.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_remote_post( $url, $args = array() ) {
 	$http = _wp_http_get_object();
 	return $http->post( $url, $args );
 }
 /**
-* Retrieve the raw response from the HTTP request using the HEAD method.
+* Performs an HTTP request using the HEAD method and returns its response.
 *
 * @since 2.7.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
-* @param string $url  Site URL to retrieve.
+* @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
-* @return WP_Error|array The response or WP_Error on failure.
+* @return array|WP_Error The response or WP_Error on failure.
 */
 function wp_remote_head( $url, $args = array() ) {
 	$http = _wp_http_get_object();
 	return $http->head( $url, $args );
 }
 * @since 2.7.0
 * @since 4.6.0 Return value changed from an array to an Requests_Utility_CaseInsensitiveDictionary instance.
 *
 * @see \Requests_Utility_CaseInsensitiveDictionary
 *
-* @param array $response HTTP response.
+* @param array|WP_Error $response HTTP response.
 * @return array|\Requests_Utility_CaseInsensitiveDictionary The headers of the response. Empty array if incorrect parameter given.
 */
 function wp_remote_retrieve_headers( $response ) {
 	if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
 		return array();
 /**
 * Retrieve a single header by name from the raw response.
 *
 * @since 2.7.0
 *
-* @param array  $response
+* @param array|WP_Error $response HTTP response.
-* @param string $header Header name to retrieve value from.
+* @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.
 */
 function wp_remote_retrieve_header( $response, $header ) {
 	if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
 		return '';
 *
 * Will return an empty array if incorrect parameter value is given.
 *
 * @since 2.7.0
 *
-* @param array $response HTTP response.
+* @param array|WP_Error $response HTTP response.
 * @return int|string The response code as an integer. Empty string on incorrect parameter given.
 */
 function wp_remote_retrieve_response_code( $response ) {
 	if ( is_wp_error( $response ) || ! isset( $response['response'] ) || ! is_array( $response['response'] ) ) {
 		return '';
 *
 * Will return an empty array if incorrect parameter value is given.
 *
 * @since 2.7.0
 *
-* @param array $response HTTP response.
+* @param array|WP_Error $response HTTP response.
 * @return string The response message. Empty string on incorrect parameter given.
 */
 function wp_remote_retrieve_response_message( $response ) {
 	if ( is_wp_error( $response ) || ! isset( $response['response'] ) || ! is_array( $response['response'] ) ) {
 		return '';
 /**
 * Retrieve only the body from the raw response.
 *
 * @since 2.7.0
 *
-* @param array $response HTTP response.
+* @param array|WP_Error $response HTTP response.
 * @return string The body of the response. Empty string if no body or incorrect parameter given.
 */
 function wp_remote_retrieve_body( $response ) {
 	if ( is_wp_error( $response ) || ! isset( $response['body'] ) ) {
 		return '';
 /**
 * Retrieve only the cookies from the raw response.
 *
 * @since 4.4.0
 *
-* @param array $response HTTP response.
+* @param array|WP_Error $response HTTP response.
-* @return array An array of `WP_Http_Cookie` objects from the response. Empty array if there are none, or the response is a WP_Error.
+* @return WP_Http_Cookie[] An array of `WP_Http_Cookie` objects from the response. Empty array if there are none, or the response is a WP_Error.
 */
 function wp_remote_retrieve_cookies( $response ) {
 	if ( is_wp_error( $response ) || empty( $response['cookies'] ) ) {
 		return array();
 	}
 /**
 * Retrieve a single cookie by name from the raw response.
 *
 * @since 4.4.0
 *
-* @param array  $response HTTP response.
+* @param array|WP_Error $response HTTP response.
-* @param string $name     The name of the cookie to retrieve.
+* @param string         $name     The name of the cookie to retrieve.
 * @return WP_Http_Cookie|string The `WP_Http_Cookie` object. Empty string if the cookie isn't present in the response.
 */
 function wp_remote_retrieve_cookie( $response, $name ) {
 	$cookies = wp_remote_retrieve_cookies( $response );
 /**
 * Retrieve a single cookie's value by name from the raw response.
 *
 * @since 4.4.0
 *
-* @param array  $response HTTP response.
+* @param array|WP_Error $response HTTP response.
-* @param string $name     The name of the cookie to retrieve.
+* @param string         $name     The name of the cookie to retrieve.
 * @return string The value of the cookie. Empty string if the cookie isn't present in the response.
 */
 function wp_remote_retrieve_cookie_value( $response, $name ) {
 	$cookie = wp_remote_retrieve_cookie( $response, $name );
 	$capabilities = wp_parse_args( $capabilities );
 	$count = count( $capabilities );
-	// If we have a numeric $capabilities array, spoof a wp_remote_request() associative $args array
+	// If we have a numeric $capabilities array, spoof a wp_remote_request() associative $args array.
 	if ( $count && count( array_filter( array_keys( $capabilities ), 'is_numeric' ) ) == $count ) {
 		$capabilities = array_combine( array_values( $capabilities ), array_fill( 0, $count, true ) );
 	}
 	if ( $url && ! isset( $capabilities['ssl'] ) ) {
 		$scheme = parse_url( $url, PHP_URL_SCHEME );
-		if ( 'https' == $scheme || 'ssl' == $scheme ) {
+		if ( 'https' === $scheme || 'ssl' === $scheme ) {
 			$capabilities['ssl'] = true;
 		}
 	}
 	return (bool) $http->_get_first_available_transport( $capabilities );
 /**
 * Retrieve list of allowed HTTP origins.
 *
 * @since 3.4.0
 *
-* @return array Array of origin URLs.
+* @return string[] Array of origin URLs.
 */
 function get_allowed_http_origins() {
 	$admin_origin = parse_url( admin_url() );
 	$home_origin  = parse_url( home_url() );
-	// @todo preserve port?
+	// @todo Preserve port?
 	$allowed_origins = array_unique(
 		array(
 			'http://' . $admin_origin['host'],
 			'https://' . $admin_origin['host'],
 			'http://' . $home_origin['host'],
 	/**
 	 * Change the origin types allowed for HTTP requests.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param array $allowed_origins {
+	 * @param string[] $allowed_origins {
-	 *     Default allowed HTTP origins.
+	 *     Array of default allowed HTTP origins.
-	 *     @type string Non-secure URL for admin origin.
+	 *
-	 *     @type string Secure URL for admin origin.
+	 *     @type string $0 Non-secure URL for admin origin.
-	 *     @type string Non-secure URL for home origin.
+	 *     @type string $1 Secure URL for admin origin.
-	 *     @type string Secure URL for home origin.
+	 *     @type string $2 Non-secure URL for home origin.
+	 *     @type string $3 Secure URL for home origin.
 	 * }
 	 */
 	return apply_filters( 'allowed_http_origins', $allowed_origins );
 }
 	if ( null === $origin ) {
 		$origin = get_http_origin();
 	}
-	if ( $origin && ! in_array( $origin, get_allowed_http_origins() ) ) {
+	if ( $origin && ! in_array( $origin, get_allowed_http_origins(), true ) ) {
 		$origin = '';
 	}
 	/**
 	 * Change the allowed HTTP origin result.
 */
 function send_origin_headers() {
 	$origin = get_http_origin();
 	if ( is_allowed_http_origin( $origin ) ) {
-		@header( 'Access-Control-Allow-Origin: ' . $origin );
+		header( 'Access-Control-Allow-Origin: ' . $origin );
-		@header( 'Access-Control-Allow-Credentials: true' );
+		header( 'Access-Control-Allow-Credentials: true' );
 		if ( 'OPTIONS' === $_SERVER['REQUEST_METHOD'] ) {
 			exit;
 		}
 		return $origin;
 	}
 /**
 * Validate a URL for safe use in the HTTP API.
 *
 * @since 3.5.2
 *
-* @param string $url
+* @param string $url Request URL.
-* @return false|string URL or false on failure.
+* @return string|false URL or false on failure.
 */
 function wp_http_validate_url( $url ) {
 	$original_url = $url;
 	$url          = wp_kses_bad_protocol( $url, array( 'http', 'https' ) );
 	if ( ! $url || strtolower( $url ) !== strtolower( $original_url ) ) {
 		return false;
 	}
-	$parsed_url = @parse_url( $url );
+	$parsed_url = parse_url( $url );
 	if ( ! $parsed_url || empty( $parsed_url['host'] ) ) {
 		return false;
 	}
 	if ( isset( $parsed_url['user'] ) || isset( $parsed_url['pass'] ) ) {
 	if ( false !== strpbrk( $parsed_url['host'], ':#?[]' ) ) {
 		return false;
 	}
-	$parsed_home = @parse_url( get_option( 'home' ) );
+	$parsed_home = parse_url( get_option( 'home' ) );
 	if ( isset( $parsed_home['host'] ) ) {
 		$same_host = strtolower( $parsed_home['host'] ) === strtolower( $parsed_url['host'] );
 	} else {
 		$same_host = false;
 		$host = trim( $parsed_url['host'], '.' );
 		if ( preg_match( '#^(([1-9]?\d|1\d\d|25[0-5]|2[0-4]\d)\.){3}([1-9]?\d|1\d\d|25[0-5]|2[0-4]\d)$#', $host ) ) {
 			$ip = $host;
 		} else {
 			$ip = gethostbyname( $host );
-			if ( $ip === $host ) { // Error condition for gethostbyname()
+			if ( $ip === $host ) { // Error condition for gethostbyname().
 				return false;
 			}
 		}
 		if ( $ip ) {
 			$parts = array_map( 'intval', explode( '.', $ip ) );
 				 *
 				 * Allows to change and allow external requests for the HTTP request.
 				 *
 				 * @since 3.6.0
 				 *
-				 * @param bool   false Whether HTTP request is external or not.
+				 * @param bool   $external Whether HTTP request is external or not.
-				 * @param string $host IP of the requested host.
+				 * @param string $host     Host name of the requested URL.
-				 * @param string $url  URL of the requested host.
+				 * @param string $url      Requested URL.
 				 */
 				if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) ) {
 					return false;
 				}
 			}
 	return false;
 }
 /**
-* Whitelists allowed redirect hosts for safe HTTP requests as well.
+* Mark allowed redirect hosts safe for HTTP requests as well.
 *
 * Attached to the {@see 'http_request_host_is_external'} filter.
 *
 * @since 3.6.0
 *
 	}
 	return $is_external;
 }
 /**
-* Whitelists any domain in a multisite installation for safe HTTP requests.
+* Adds any domain in a multisite installation for safe HTTP requests to the
+* allowed list.
 *
 * Attached to the {@see 'http_request_host_is_external'} filter.
 *
 * @since 3.6.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
-* @staticvar array $queried
 *
 * @param bool   $is_external
 * @param string $host
 * @return bool
 */
 	global $wpdb;
 	static $queried = array();
 	if ( $is_external ) {
 		return $is_external;
 	}
-	if ( $host === get_network()->domain ) {
+	if ( get_network()->domain === $host ) {
 		return true;
 	}
 	if ( isset( $queried[ $host ] ) ) {
 		return $queried[ $host ];
 	}
 *
 * Secondly, across various PHP versions, schemeless URLs starting containing a ":"
 * in the query are being handled inconsistently. This function works around those
 * differences as well.
 *
-* Error suppression is used as prior to PHP 5.3.3, an E_WARNING would be generated
-* when URL parsing failed.
-*
 * @since 4.4.0
 * @since 4.7.0 The `$component` parameter was added for parity with PHP's `parse_url()`.
 *
-* @link https://secure.php.net/manual/en/function.parse-url.php
+* @link https://www.php.net/manual/en/function.parse-url.php
 *
 * @param string $url       The URL to parse.
 * @param int    $component The specific component to retrieve. Use one of the PHP
 *                          predefined constants to specify which one.
 *                          Defaults to -1 (= return all parts as an array).
 		$to_unset[] = 'scheme';
 		$to_unset[] = 'host';
 		$url        = 'placeholder://placeholder' . $url;
 	}
-	$parts = @parse_url( $url );
+	$parts = parse_url( $url );
 	if ( false === $parts ) {
 		// Parsing failure.
 		return $parts;
 	}
 * @internal
 *
 * @since 4.7.0
 * @access private
 *
-* @link https://secure.php.net/manual/en/function.parse-url.php
+* @link https://www.php.net/manual/en/function.parse-url.php
 *
 * @param array|false $url_parts The parsed URL. Can be false if the URL failed to parse.
-* @param int    $component The specific component to retrieve. Use one of the PHP
+* @param int         $component The specific component to retrieve. Use one of the PHP
-*                          predefined constants to specify which one.
+*                               predefined constants to specify which one.
-*                          Defaults to -1 (= return all parts as an array).
+*                               Defaults to -1 (= return all parts as an array).
 * @return mixed False on parse failure; Array of URL components on success;
 *               When a specific component has been requested: null if the component
 *               doesn't exist in the given URL; a string or - in the case of
 *               PHP_URL_PORT - integer when it does. See parse_url()'s return values.
 */
 * @internal
 *
 * @since 4.7.0
 * @access private
 *
-* @link https://secure.php.net/manual/en/url.constants.php
+* @link https://www.php.net/manual/en/url.constants.php
 *
 * @param int $constant PHP_URL_* constant.
-* @return string|bool The named key or false.
+* @return string|false The named key or false.
 */
 function _wp_translate_php_url_constant_to_key( $constant ) {
 	$translation = array(
 		PHP_URL_SCHEME   => 'scheme',
 		PHP_URL_HOST     => 'host',

changeset 16	a86126ab1dd4
parent 13	d255fe9cd479
child 18	be944660c56a