IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
See #42505.
Built from https://develop.svn.wordpress.org/trunk@42775


git-svn-id: http://core.svn.wordpress.org/trunk@42605 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2018-03-04 19:50:31 +00:00
parent 7b7ca428f3
commit 3c8ae81018
2 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
wp-admin/includes/file.php
View File

@@ -958,14 +958,15 @@ function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
/**
* Downloads a URL to a local temporary file using the WordPress HTTP Class.
* Please note, That the calling function must unlink() the file.
* Downloads a URL to a local temporary file using the WordPress HTTP API.
*
* Please note that the calling function must unlink() the file.
*
* @since 2.5.0
*
* @param string $url the URL of the file to download
* @param int $timeout The timeout for the request to download the file default 300 seconds
* @return mixed WP_Error on failure, string Filename on success.
* @param string $url The URL of the file to download.
* @param int $timeout The timeout for the request to download the file. Default 300 seconds.
* @return string|WP_Error Filename on success, WP_Error on failure.
*/
function download_url( $url, $timeout = 300 ) {
//WARNING: The file is not automatically deleted, The script must unlink() the file.