Changeset 58715 for trunk/src/wp-includes/functions.php

Timestamp:

07/13/2024 05:01:47 AM (10 months ago)

Author:

SergeyBiryukov

Message:

Filesystem API: Add a return value for wp_delete_file().

This addresses a discrepancy where using unlink() allows for checking if it was successful via the return value, but wp_delete_file() did not have a return value, making it impossible to verify the result without doing overhead checks if the file still exists.

This also brings more consistency with the other wp_delete_*() functions, specifically:

• wp_delete_file_from_directory()
• wp_delete_post()
• wp_delete_post_revision()
• wp_delete_attachment()
• wp_delete_attachment_files()
• wp_delete_comment()
• wp_delete_nav_menu()
• wp_delete_term()
• wp_delete_site()
• wp_delete_user()

Includes adding basic unit tests for wp_delete_file().

Follow-up to [31575].

Props bedas, debarghyabanerjee, mukesh27, SergeyBiryukov.
Fixes #61590.

File:

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

trunk/src/wp-includes/functions.php

@@ -7645 +7645 @@
  *
  * @since 4.2.0
+ * @since 6.7.0 A return value was added.
  *
  * @param string $file The path to the file to delete.
+ * @return bool True on success, false on failure.
  */
 function wp_delete_file( $file ) {
@@ -7657 +7659 @@
      */
     $delete = apply_filters( 'wp_delete_file', $file );
+
     if ( ! empty( $delete ) ) {
-        @unlink( $delete );
-    }
+        return @unlink( $delete );
+    }
+
+    return false;
 }
 
@@ -7692 +7697 @@
     }
 
-    wp_delete_file( $file );
-
-    return true;
+    return wp_delete_file( $file );
 }