Curl::request( string|WpOrg\Requests\Transport\Stringable $url, array $headers = [], string|array $data = [], array $options = [] ): string

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|WpOrg\Requests\Transport\Stringable

URL to request

$headersarrayoptional

Associative array of request headersDefault: []

$datastring|arrayoptional

Data to send either as the POST body, or as parameters in the URL for a GET/HEADDefault: []

$optionsarrayoptional

Request options, see \WpOrg\Requests\Requests::response() for documentationDefault: []

Return value

string

Raw HTTP result

Performance profile

How much work a call to 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

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

17–151

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• filesystemfilesystem accessfopen()called directly

What one call costs · 26 distinct outcomes

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

Uses · 5

• \WpOrg\Requests\Utility\InputValidator::is_string_or_stringable()
• \WpOrg\Requests\Exception\InvalidArgument::create()
• \WpOrg\Requests\Transport\Curl::setup_handle()
• \WpOrg\Requests\Exception::__construct()
• \WpOrg\Requests\Transport\Curl::process_response()

Source code

View on Trac ↗View on GitHub ↗

149	public function request($url, $headers = [], $data = [], $options = []) {150		if (InputValidator::is_string_or_stringable($url) === false) {151			throw InvalidArgument::create(1, '$url', 'string|Stringable', gettype($url));152		}153 154		if (is_array($headers) === false) {155			throw InvalidArgument::create(2, '$headers', 'array', gettype($headers));156		}157 158		if (!is_array($data) && !is_string($data)) {159			if ($data === null) {160				$data = '';161			} else {162				throw InvalidArgument::create(3, '$data', 'array|string', gettype($data));163			}164		}165 166		if (is_array($options) === false) {167			throw InvalidArgument::create(4, '$options', 'array', gettype($options));168		}169 170		$this->hooks = $options['hooks'];171 172		$this->setup_handle($url, $headers, $data, $options);173 174		$options['hooks']->dispatch('curl.before_send', [&$this->handle]);175 176		if ($options['filename'] !== false) {177			// phpcs:ignore WordPress.PHP.NoSilencedErrors -- Silenced the PHP native warning in favour of throwing an exception.178			$this->stream_handle = @fopen($options['filename'], 'wb');179			if ($this->stream_handle === false) {180				$error = error_get_last();181				throw new Exception($error['message'], 'fopen');182			}183		}184 185		$this->response_data       = '';186		$this->response_bytes      = 0;187		$this->response_byte_limit = false;188		if ($options['max_bytes'] !== false) {189			$this->response_byte_limit = $options['max_bytes'];190		}191 192		if (isset($options['verify'])) {193			if ($options['verify'] === false) {194				curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);195				curl_setopt($this->handle, CURLOPT_SSL_VERIFYPEER, 0);196			} elseif (is_string($options['verify'])) {197				curl_setopt($this->handle, CURLOPT_CAINFO, $options['verify']);198			}199		}200 201		if (isset($options['verifyname']) && $options['verifyname'] === false) {202			curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);203		}204 205		curl_exec($this->handle);206		$response = $this->response_data;207 208		$options['hooks']->dispatch('curl.after_send', []);209 210		if (curl_errno($this->handle) === CURLE_WRITE_ERROR || curl_errno($this->handle) === CURLE_BAD_CONTENT_ENCODING) {211			// Reset encoding and try again212			curl_setopt($this->handle, CURLOPT_ENCODING, 'none');213 214			$this->response_data  = '';215			$this->response_bytes = 0;216			curl_exec($this->handle);217			$response = $this->response_data;218		}219 220		$this->process_response($response, $options);221 222		// Need to remove the $this reference from the curl handle.223		// Otherwise \WpOrg\Requests\Transport\Curl won't be garbage collected and the curl_close() will never be called.224		curl_setopt($this->handle, CURLOPT_HEADERFUNCTION, null);225		curl_setopt($this->handle, CURLOPT_WRITEFUNCTION, null);226 227		return $this->headers;228	}

Changelog

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/Requests/src/Transport/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.