Changeset 56929

Timestamp:

10/13/2023 12:18:19 PM (16 months ago)

Author:

SergeyBiryukov

Message:

Media: Consistently call the wp_create_file_in_uploads hook as a filter.

The filter was initially introduced for file replication purposes. Since the returned value is not always used directly, some instances were later converted to an action as part of removing unused variables, and the hook was documented as an action while still being called as a filter in other instances.

This commit aims to correct the discrepancy between the code and the documentation.

Follow-up to [4673], [4817], [4818], [6363], [6551], [13041], [25821], [33154], [33280].

Props Howdy_McGee, nicolefurlan, johnbillion, mhshujon, SergeyBiryukov.
Fixes #57775.

Location:

trunk/src/wp-admin/includes

Files:

• class-custom-background.php (modified) (1 diff)
• class-custom-image-header.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-custom-background.php

@@ -572 +572 @@
         set_theme_mod( 'background_image_thumb', sanitize_url( $thumbnail[0] ) );
 
-        /** This action is documented in wp-admin/includes/class-custom-image-header.php */
-        do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication.
+        /** This filter is documented in wp-admin/includes/class-custom-image-header.php */
+        $file = apply_filters( 'wp_create_file_in_uploads', $file, $id ); // For replication.
+
         $this->updated = true;
     }

trunk/src/wp-admin/includes/class-custom-image-header.php

@@ -883 +883 @@
 
             /**
-             * Fires after the header image is set or an error is returned.
+             * Filters the attachment file path after the custom header or background image is set.
+             *
+             * Used for file replication.
              *
              * @since 2.1.0
@@ -890 +892 @@
              * @param int    $attachment_id Attachment ID.
              */
-            do_action( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication.
+            $file = apply_filters( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication.
 
             return $this->finished();