WordPress.org

Make WordPress Core

Changeset 42775


Ignore:
Timestamp:
03/04/2018 07:49:54 PM (4 years ago)
Author:
SergeyBiryukov
Message:

Docs: Clarify download_url() return value, improve DocBlock formatting.

See #42505.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/file.php

    r42773 r42775  
    959959
    960960/**
    961  * Downloads a URL to a local temporary file using the WordPress HTTP Class.
    962  * Please note, That the calling function must unlink() the file.
     961 * Downloads a URL to a local temporary file using the WordPress HTTP API.
     962 *
     963 * Please note that the calling function must unlink() the file.
    963964 *
    964965 * @since 2.5.0
    965966 *
    966  * @param string $url the URL of the file to download
    967  * @param int $timeout The timeout for the request to download the file default 300 seconds
    968  * @return mixed WP_Error on failure, string Filename on success.
     967 * @param string $url  The URL of the file to download.
     968 * @param int $timeout The timeout for the request to download the file. Default 300 seconds.
     969 * @return string|WP_Error Filename on success, WP_Error on failure.
    969970 */
    970971function download_url( $url, $timeout = 300 ) {
Note: See TracChangeset for help on using the changeset viewer.