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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$urlstring

The request URL.

$argsstring|arrayoptional

Override the defaults.Default: array()

Return value

array|WP_Error

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

Performance profile

How much work a call to WP_Http_Curl::request() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via fopen().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

151–230

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 483.

Plugin surface

3 hooks

Third-party callbacks on 'https_local_ssl_verify', 'https_ssl_verify', 'http_api_curl' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfopen()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 75 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Http_Curl::request() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while WP_Http_Curl::request() runs, in this order:

1. 1
   apply_filters( https_local_ssl_verify )filterline 122 (+49 into the body)

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

2. 2
   apply_filters( https_ssl_verify )filterline 125 (+52 into the body)

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

3. 3
   do_action( http_api_curl )actionline 236 (+163 into the body)

   Fires before the cURL request is executed.

Uses · 11

• 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.
• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.
• 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::processHeaders()Transforms header string into an array.
• WP_Http::handle_redirects()Handles an HTTP redirect and follows it if appropriate.
• WP_Http_Encoding::should_decode()Whether the content be decoded based on the headers.
• WP_Http_Encoding::decompress()Decompression of deflated string.

Source code

View on Trac ↗View on GitHub ↗

73	public function request( $url, $args = array() ) {74		$defaults = array(75			'method'      => 'GET',76			'timeout'     => 5,77			'redirection' => 5,78			'httpversion' => '1.0',79			'blocking'    => true,80			'headers'     => array(),81			'body'        => null,82			'cookies'     => array(),83			'decompress'  => false,84			'stream'      => false,85			'filename'    => null,86		);87 88		$parsed_args = wp_parse_args( $args, $defaults );89 90		if ( isset( $parsed_args['headers']['User-Agent'] ) ) {91			$parsed_args['user-agent'] = $parsed_args['headers']['User-Agent'];92			unset( $parsed_args['headers']['User-Agent'] );93		} elseif ( isset( $parsed_args['headers']['user-agent'] ) ) {94			$parsed_args['user-agent'] = $parsed_args['headers']['user-agent'];95			unset( $parsed_args['headers']['user-agent'] );96		}97 98		// Construct Cookie: header if any cookies are set.99		WP_Http::buildCookieHeader( $parsed_args );100 101		$handle = curl_init();102 103		// cURL offers really easy proxy support.104		$proxy = new WP_HTTP_Proxy();105 106		if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) {107 108			curl_setopt( $handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP );109			curl_setopt( $handle, CURLOPT_PROXY, $proxy->host() );110			curl_setopt( $handle, CURLOPT_PROXYPORT, $proxy->port() );111 112			if ( $proxy->use_authentication() ) {113				curl_setopt( $handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY );114				curl_setopt( $handle, CURLOPT_PROXYUSERPWD, $proxy->authentication() );115			}116		}117 118		$is_local   = isset( $parsed_args['local'] ) && $parsed_args['local'];119		$ssl_verify = isset( $parsed_args['sslverify'] ) && $parsed_args['sslverify'];120		if ( $is_local ) {121			/** This filter is documented in wp-includes/class-wp-http-streams.php */122			$ssl_verify = apply_filters( 'https_local_ssl_verify', $ssl_verify, $url );123		} elseif ( ! $is_local ) {124			/** This filter is documented in wp-includes/class-wp-http.php */125			$ssl_verify = apply_filters( 'https_ssl_verify', $ssl_verify, $url );126		}127 128		/*129		 * CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since.130		 * a value of 0 will allow an unlimited timeout.131		 */132		$timeout = (int) ceil( $parsed_args['timeout'] );133		curl_setopt( $handle, CURLOPT_CONNECTTIMEOUT, $timeout );134		curl_setopt( $handle, CURLOPT_TIMEOUT, $timeout );135 136		curl_setopt( $handle, CURLOPT_URL, $url );137		curl_setopt( $handle, CURLOPT_RETURNTRANSFER, true );138		curl_setopt( $handle, CURLOPT_SSL_VERIFYHOST, ( true === $ssl_verify ) ? 2 : false );139		curl_setopt( $handle, CURLOPT_SSL_VERIFYPEER, $ssl_verify );140 141		if ( $ssl_verify ) {142			curl_setopt( $handle, CURLOPT_CAINFO, $parsed_args['sslcertificates'] );143		}144 145		curl_setopt( $handle, CURLOPT_USERAGENT, $parsed_args['user-agent'] );146 147		/*148		 * The option doesn't work with safe mode or when open_basedir is set, and there's149		 * a bug #17490 with redirected POST requests, so handle redirections outside Curl.150		 */151		curl_setopt( $handle, CURLOPT_FOLLOWLOCATION, false );152		curl_setopt( $handle, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS );

Changelog

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 7.1.0 tag, from src/wp-includes/class-wp-http-curl.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.