Changeset 46655

Timestamp:

11/05/2019 06:42:43 PM (5 years ago)

Author:

azaozz

Message:

Upload:

• Run the wp_generate_attachment_metadata filter at the end in wp_update_image_subsizes() when new metadata was generated and additional image sub-sizes were created.
• Add another arg in the wp_generate_attachment_metadata filter for additional context.
• Fix inline docs and ensure the new image meta is always saved before starting image post-processing.

Props SergeyBiryukov, azaozz.
Merges [46621], [46622], and [46651] to the 5.3 branch.
Fixes #48472.

File:

• branches/5.3/src/wp-admin/includes/image.php (modified) (5 diffs)

branches/5.3/src/wp-admin/includes/image.php

@@ -143 +143 @@
         // If there is an uploaded file, make all sub-sizes and generate all of the attachment meta.
         if ( ! empty( $image_file ) ) {
-            return wp_create_image_subsizes( $image_file, $attachment_id );
+            $image_meta = wp_create_image_subsizes( $image_file, $attachment_id );
         } else {
             return new WP_Error( 'invalid_attachment', __( 'The attached file cannot be found.' ) );
         }
-    }
-
-    $missing_sizes = wp_get_missing_image_subsizes( $attachment_id );
-
-    if ( empty( $missing_sizes ) ) {
-        return $image_meta;
-    }
-
-    // This also updates the image meta.
-    return _wp_make_subsizes( $missing_sizes, $image_file, $image_meta, $attachment_id );
+    } else {
+        $missing_sizes = wp_get_missing_image_subsizes( $attachment_id );
+
+        if ( empty( $missing_sizes ) ) {
+            return $image_meta;
+        }
+
+        // This also updates the image meta.
+        $image_meta = _wp_make_subsizes( $missing_sizes, $image_file, $image_meta, $attachment_id );
+    }
+
+    /** This filter is documented in wp-admin/includes/image.php */
+    $image_meta = apply_filters( 'wp_generate_attachment_metadata', $image_meta, $attachment_id, 'update' );
+
+    // Save the updated metadata.
+    wp_update_attachment_metadata( $attachment_id, $image_meta );
+
+    return $image_meta;
 }
 
@@ -275 +283 @@
                     $image_meta['image_meta']['orientation'] = 1;
                 }
-
-                wp_update_attachment_metadata( $attachment_id, $image_meta );
             } else {
                 // TODO: log errors.
@@ -307 +313 @@
                     $image_meta['image_meta']['orientation'] = 1;
                 }
-
-                wp_update_attachment_metadata( $attachment_id, $image_meta );
             } else {
                 // TODO: log errors.
@@ -314 +318 @@
         }
     }
+
+    // Initial save of the new metadata.
+    // At this point the file was uploaded and moved to the uploads directory
+    // but the image sub-sizes haven't been created yet and the `sizes` array is empty.
+    wp_update_attachment_metadata( $attachment_id, $image_meta );
 
     $new_sizes = wp_get_registered_image_subsizes();
@@ -578 +587 @@
      *
      * @since 2.1.0
-     *
-     * @param array $metadata      An array of attachment meta data.
-     * @param int   $attachment_id Current attachment ID.
+     * @since 5.3.0 The `$context` parameter was added.
+     *
+     * @param array  $metadata      An array of attachment meta data.
+     * @param int    $attachment_id Current attachment ID.
+     * @param string $context       Additional context. Can be 'create' when metadata was initially created for new attachment
+     *                              or 'update' when the metadata was updated.
      */
-    return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
+    return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id, 'create' );
 }