Changeset 57027

Timestamp:

10/29/2023 12:14:46 AM (13 months ago)

Author:

SergeyBiryukov

Message:

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.

File:

• trunk/src/wp-admin/includes/file.php (modified) (3 diffs)

trunk/src/wp-admin/includes/file.php

@@ -657 +657 @@
  * Returns a filename of a temporary unique file.
  *
- * Please note that the calling function must unlink() this itself.
+ * Please note that the calling function must delete or move the file.
  *
  * The filename is based off the passed parameter or defaults to the current unix timestamp,
@@ -1140 +1140 @@
  * Downloads a URL to a local temporary file using the WordPress HTTP API.
  *
- * Please note that the calling function must unlink() the file.
+ * Please note that the calling function must delete or move the file.
  *
  * @since 2.5.0
@@ -1154 +1154 @@
  */
 function download_url( $url, $timeout = 300, $signature_verification = false ) {
-    // WARNING: The file is not automatically deleted, the script must unlink() the file.
+    // WARNING: The file is not automatically deleted, the script must delete or move the file.
     if ( ! $url ) {
         return new WP_Error( 'http_no_url', __( 'Invalid URL Provided.' ) );