WordPress.org

Make WordPress Core

Changeset 35937


Ignore:
Timestamp:
12/14/2015 11:40:55 PM (4 years ago)
Author:
DrewAPicture
Message:

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

See #32246.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-http-curl.php

    r35930 r35937  
    317317
    318318    /**
    319      * Grab the body of the cURL request
    320      *
    321      * The contents of the document are passed in chunks, so we append to the $body property for temporary storage.
    322      * Returning a length shorter than the length of $data passed in will cause cURL to abort the request with CURLE_WRITE_ERROR
     319     * Grabs the body of the cURL request.
     320     *
     321     * The contents of the document are passed in chunks, so we append to the `$body`
     322     * property for temporary storage. Returning a length shorter than the length of
     323     * `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`.
    323324     *
    324325     * @since 3.6.0
    325326     * @access private
    326      * @return int
     327     *
     328     * @param resource $handle  cURL handle.
     329     * @param string   $headers cURL request headers.
     330     * @return int Total bytes of data written.
    327331     */
    328332    private function stream_body( $handle, $data ) {
Note: See TracChangeset for help on using the changeset viewer.