Skip to content

Commit ffcf5fb

Browse files
Docs: Improve documentation for wp_tempnam() and download_url().
Instead of mentioning the `unlink()` function specifically, the DocBlock should state that the calling function must delete or move the temporary file. Follow-up to [6779], [12151]. Props bedas. Fixes #59761. git-svn-id: https://develop.svn.wordpress.org/trunk@57027 602fd350-edb4-49c9-b593-d223f7449a82
1 parent cc2133f commit ffcf5fb

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/wp-admin/includes/file.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,7 @@ function wp_edit_theme_plugin_file( $args ) {
656656
/**
657657
* Returns a filename of a temporary unique file.
658658
*
659-
* Please note that the calling function must unlink() this itself.
659+
* Please note that the calling function must delete or move the file.
660660
*
661661
* The filename is based off the passed parameter or defaults to the current unix timestamp,
662662
* while the directory can either be passed as well, or by leaving it blank, default to a writable
@@ -1139,7 +1139,7 @@ function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
11391139
/**
11401140
* Downloads a URL to a local temporary file using the WordPress HTTP API.
11411141
*
1142-
* Please note that the calling function must unlink() the file.
1142+
* Please note that the calling function must delete or move the file.
11431143
*
11441144
* @since 2.5.0
11451145
* @since 5.2.0 Signature Verification with SoftFail was added.
@@ -1153,7 +1153,7 @@ function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
11531153
* @return string|WP_Error Filename on success, WP_Error on failure.
11541154
*/
11551155
function download_url( $url, $timeout = 300, $signature_verification = false ) {
1156-
// WARNING: The file is not automatically deleted, the script must unlink() the file.
1156+
// WARNING: The file is not automatically deleted, the script must delete or move the file.
11571157
if ( ! $url ) {
11581158
return new WP_Error( 'http_no_url', __( 'Invalid URL Provided.' ) );
11591159
}

0 commit comments

Comments
 (0)