Docs: Add missing parameter and return descriptions to the DocBlock for `WP_Http_Curl::stream_body()`.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35937 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-12-14 23:40:55 +00:00
parent 5effdb5445
commit e20a31a888
1 changed files with 8 additions and 4 deletions

View File

@ -316,14 +316,18 @@ class WP_Http_Curl {
}
/**
* Grab the body of the cURL request
* Grabs the body of the cURL request.
*
* The contents of the document are passed in chunks, so we append 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
* The contents of the document are passed in chunks, so we append 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`.
*
* @since 3.6.0
* @access private
* @return int
*
* @param resource $handle cURL handle.
* @param string $headers cURL request headers.
* @return int Total bytes of data written.
*/
private function stream_body( $handle, $data ) {
$data_length = strlen( $data );