wppaste
WordPress

WP_Http_Curl::stream_body( resource $handle, string $data ): int

Since
3.6.0
Source
wp-includes/class-wp-http-curl.php:391
Grabs the body of the cURL request.

Description

The contents of the document are passed in chunks, and are appended to the $body property for temporary storage. Returning a length shorter than the length of $data passed in will cause cURL to abort the request with CURLE_WRITE_ERROR.

Parameters

$handleresource
cURL handle.
$datastring
cURL request body.

Return

int
Total bytes of data written.

Source

	private function stream_body( $handle, $data ) {		$data_length = strlen( $data ); 		if ( $this->max_body_length && ( $this->bytes_written_total + $data_length ) > $this->max_body_length ) {			$data_length = ( $this->max_body_length - $this->bytes_written_total );			$data        = substr( $data, 0, $data_length );		} 		if ( $this->stream_handle ) {			$bytes_written = fwrite( $this->stream_handle, $data );		} else {			$this->body   .= $data;			$bytes_written = $data_length;		} 		$this->bytes_written_total += $bytes_written; 		// Upon event of this function returning less than strlen( $data ) curl will error with CURLE_WRITE_ERROR.		return $bytes_written;	}

History

Introduced in 3.6.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.