Changeset 41732

Timestamp:

10/04/2017 02:58:07 PM (7 years ago)

Author:

joemcgill

Message:

Customizer: Minimize duplicate header crops in the media library.

This adds Custom_Image_Header::get_previous_crop(), which finds any
previously cropped headers created from the same base image and replaces
that attachment rather than creating a new attachment.

After updating a crop, the replaced images is also removed from the list
of previous header images in the Customizer.

See #21819.

Location:

trunk

Files:

• src/wp-admin/custom-header.php (modified) (5 diffs)
• src/wp-includes/js/customize-models.js (modified) (2 diffs)
• src/wp-includes/theme.php (modified) (1 diff)
• tests/phpunit/tests/image/header.php (modified) (1 diff)

trunk/src/wp-admin/custom-header.php

@@ -1165 +1165 @@
             'post_mime_type' => $image_type,
             'guid' => $url,
-            'context' => 'custom-header'
+            'context' => 'custom-header',
+            'post_parent' => $parent_attachment_id,
         );
 
@@ -1181 +1182 @@
      */
     final public function insert_attachment( $object, $cropped ) {
+        $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null;
+        unset( $object['post_parent'] );
+
         $attachment_id = wp_insert_attachment( $object, $cropped );
         $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
+
         /**
          * Filters the header image attachment metadata.
@@ -1194 +1199 @@
         $metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata );
         wp_update_attachment_metadata( $attachment_id, $metadata );
+
+        if ( $parent_id ) {
+            $meta = add_post_meta( $attachment_id, '_wp_attachment_parent', $parent_id, true );
+        }
+
         return $attachment_id;
     }
@@ -1242 +1252 @@
         $object = $this->create_attachment_object( $cropped, $attachment_id );
 
-        unset( $object['ID'] );
+        $previous = $this->get_previous_crop( $object );
+
+        if ( $previous ) {
+            $object['ID'] = $previous;
+        } else {
+            unset( $object['ID'] );
+        }
 
         $new_attachment_id = $this->insert_attachment( $object, $cropped );
@@ -1397 +1413 @@
         return $header_images;
     }
+
+    /**
+     * Get the ID of a previous crop from the same base image.
+     *
+     * @since 4.9.0
+     *
+     * @param  array $object A crop attachment object.
+     * @return int|false An attachment ID if one exists. False if none.
+     */
+    public function get_previous_crop( $object ) {
+        $header_images = $this->get_uploaded_header_images();
+
+        // Bail early if there are no header images.
+        if ( empty( $header_images ) ) {
+            return false;
+        }
+
+        $previous = false;
+
+        foreach ( $header_images as $image ) {
+            if ( $image['attachment_parent'] === $object['post_parent'] ) {
+                $previous = $image['attachment_id'];
+                break;
+            }
+        }
+
+        return $previous;
+    }
 }

trunk/src/wp-includes/js/customize-models.js

@@ -165 +165 @@
             this.on('control:setImage', this.setImage, this);
             this.on('control:removeImage', this.removeImage, this);
+            this.on('add', this.maybeRemoveOldCrop, this);
             this.on('add', this.maybeAddRandomChoice, this);
 
@@ -185 +186 @@
             if (this.size() > 0) {
                 this.addRandomChoice(current);
+            }
+        },
+
+        maybeRemoveOldCrop: function( model ) {
+            var newID = model.get( 'header' ).attachment_id || false,
+                oldCrop;
+
+            // Bail early if we don't have a new attachment ID.
+            if ( ! newID ) {
+                return;
+            }
+
+            oldCrop = this.find( function( item ) {
+                return ( item.cid !== model.cid && item.get( 'header' ).attachment_id === newID );
+            } );
+
+            // If we found an old crop, remove it from the collection.
+            if ( oldCrop ) {
+                this.remove( oldCrop );
             }
         },

trunk/src/wp-includes/theme.php

@@ -1215 +1215 @@
         $header_images[$header_index]['thumbnail_url'] = $url;
         $header_images[$header_index]['alt_text'] = get_post_meta( $header->ID, '_wp_attachment_image_alt', true );
+        $header_images[$header_index]['attachment_parent'] = (int) get_post_meta( $header->ID, '_wp_attachment_parent', true );
 
         if ( isset( $header_data['width'] ) )

trunk/tests/phpunit/tests/image/header.php

@@ -138 +138 @@
     }
 
+    /**
+     * @ticket 21819
+     */
+    function test_check_get_previous_crop() {
+        $id = wp_insert_attachment( array(
+            'post_status' => 'publish',
+            'post_title' => 'foo.png',
+            'post_type' => 'post',
+            'guid' => 'http://localhost/foo.png'
+        ) );
+
+        // Create inital crop object.
+        $cropped_1 = 'foo-cropped-1.png';
+        $object = $this->custom_image_header->create_attachment_object( $cropped_1, $id );
+
+        // Ensure no previous crop exists.
+        $previous = $this->custom_image_header->get_previous_crop( $object );
+        $this->assertFalse( $previous );
+
+        // Create the inital crop attachment and set it as the header.
+        $cropped_1_id = $this->custom_image_header->insert_attachment( $object, $cropped_1 );
+        $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
+        update_post_meta( $cropped_1_id, $key, time() );
+        update_post_meta( $cropped_1_id, '_wp_attachment_is_custom_header', get_stylesheet() );
+
+        // Create second crop.
+        $cropped_2 = 'foo-cropped-2.png';
+        $object = $this->custom_image_header->create_attachment_object( $cropped_2, $id );
+
+        // Test that a previous crop is found.
+        $previous = $this->custom_image_header->get_previous_crop( $object );
+        $this->assertSame( $previous, $cropped_1_id );
+    }
 }