WP_Http_Streams::request( string $url, string|array $args = array() ): array|WP_Error

Parameters

$urlstring

The request URL.

$argsstring|arrayoptional

Override the defaults.Default: array()

Return

array|WP_Error

Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error

Hooks fired · 2

2 hooks fire while WP_Http_Streams::request() runs, in this order:

1. 1
   apply_filters( https_local_ssl_verify )filterline 113 (+81 into the body)

   Filters whether SSL should be verified for local HTTP API requests.

2. 2
   apply_filters( https_ssl_verify )filterline 116 (+84 into the body)

   Filters whether SSL should be verified for non-local requests.

Uses · 13

• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• WP_Http::buildCookieHeader()Takes the arguments for a ::request() and checks for the cookie array.
• WP_HTTP_Proxy::__construct()
• WP_Error::__construct()Initializes the error.
• WP_Http_Streams::verify_ssl_certificate()Verifies the received SSL certificate against its Common Names and subjectAltName fields.
• WP_Http::processResponse()Parses the responses and splits the parts into headers and body.
• WP_Http::processHeaders()Transforms header string into an array.
• WP_Http::handle_redirects()Handles an HTTP redirect and follows it if appropriate.
• WP_Http::chunkTransferDecode()Decodes chunk transfer-encoding, based off the HTTP 1.1 specification.
• WP_Http_Encoding::should_decode()Whether the content be decoded based on the headers.

Source

View on Trac ↗View on GitHub ↗

32	public function request( $url, $args = array() ) {33		$defaults = array(34			'method'      => 'GET',35			'timeout'     => 5,36			'redirection' => 5,37			'httpversion' => '1.0',38			'blocking'    => true,39			'headers'     => array(),40			'body'        => null,41			'cookies'     => array(),42			'decompress'  => false,43			'stream'      => false,44			'filename'    => null,45		);46 47		$parsed_args = wp_parse_args( $args, $defaults );48 49		if ( isset( $parsed_args['headers']['User-Agent'] ) ) {50			$parsed_args['user-agent'] = $parsed_args['headers']['User-Agent'];51			unset( $parsed_args['headers']['User-Agent'] );52		} elseif ( isset( $parsed_args['headers']['user-agent'] ) ) {53			$parsed_args['user-agent'] = $parsed_args['headers']['user-agent'];54			unset( $parsed_args['headers']['user-agent'] );55		}56 57		// Construct Cookie: header if any cookies are set.58		WP_Http::buildCookieHeader( $parsed_args );59 60		$parsed_url = parse_url( $url );61 62		$connect_host = $parsed_url['host'];63 64		$secure_transport = ( 'ssl' === $parsed_url['scheme'] || 'https' === $parsed_url['scheme'] );65		if ( ! isset( $parsed_url['port'] ) ) {66			if ( 'ssl' === $parsed_url['scheme'] || 'https' === $parsed_url['scheme'] ) {67				$parsed_url['port'] = 443;68				$secure_transport   = true;69			} else {70				$parsed_url['port'] = 80;71			}72		}73 74		// Always pass a path, defaulting to the root in cases such as http://example.com.75		if ( ! isset( $parsed_url['path'] ) ) {76			$parsed_url['path'] = '/';77		}78 79		if ( isset( $parsed_args['headers']['Host'] ) || isset( $parsed_args['headers']['host'] ) ) {80			if ( isset( $parsed_args['headers']['Host'] ) ) {81				$parsed_url['host'] = $parsed_args['headers']['Host'];82			} else {83				$parsed_url['host'] = $parsed_args['headers']['host'];84			}85			unset( $parsed_args['headers']['Host'], $parsed_args['headers']['host'] );86		}87 88		/*89		 * Certain versions of PHP have issues with 'localhost' and IPv6, It attempts to connect90		 * to ::1, which fails when the server is not set up for it. For compatibility, always91		 * connect to the IPv4 address.92		 */93		if ( 'localhost' === strtolower( $connect_host ) ) {94			$connect_host = '127.0.0.1';95		}96 97		$connect_host = $secure_transport ? 'ssl://' . $connect_host : 'tcp://' . $connect_host;98 99		$is_local   = isset( $parsed_args['local'] ) && $parsed_args['local'];100		$ssl_verify = isset( $parsed_args['sslverify'] ) && $parsed_args['sslverify'];101 102		if ( $is_local ) {103			/**104			 * Filters whether SSL should be verified for local HTTP API requests.105			 *106			 * @since 2.8.0107			 * @since 5.1.0 The `$url` parameter was added.108			 *109			 * @param bool|string $ssl_verify Boolean to control whether to verify the SSL connection110			 *                                or path to an SSL certificate.111			 * @param string      $url        The request URL.

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-http-streams.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.