Changeset 57755

Timestamp:

03/02/2024 08:13:02 PM (5 months ago)

Author:

joedolson

Message:

Media: Accessibility: Copy attachment properties on site icon crop.

Add parity between site icon, custom header, and default image crop behaviors. [53027] fixed a bug where alt text and caption were not copied on custom headers, but did not apply that change in any other context.

Deprecate the create_attachment_object method in the Wp_Site_Icon and Custom_Image_Header classes and replace that functionality with the new function wp_copy_parent_attachment_properties() to improve consistency.

Props afercia, rcreators, jorbin, joedolson, huzaifaalmesbah, shailu25, swissspidy, mukesh27.
Fixes #60524.

Location:

trunk

Files:

• src/wp-admin/includes/ajax-actions.php (modified) (2 diffs)
• src/wp-admin/includes/class-custom-image-header.php (modified) (4 diffs)
• src/wp-admin/includes/class-wp-site-icon.php (modified) (2 diffs)
• src/wp-admin/includes/image.php (modified) (1 diff)
• tests/phpunit/tests/image/header.php (modified) (4 diffs)
• tests/phpunit/tests/image/siteIcon.php (modified) (2 diffs)
• tests/phpunit/tests/media/wpCopyParentAttachmentProperties.php (added)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -4036 +4036 @@
 
             /** This filter is documented in wp-admin/includes/class-custom-image-header.php */
-            $cropped    = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
-            $attachment = $wp_site_icon->create_attachment_object( $cropped, $attachment_id );
-            unset( $attachment['ID'] );
+            $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
+
+            // Copy attachment properties.
+            $attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, $context );
 
             // Update the attachment.
@@ -4066 +4067 @@
             $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
 
-            $parent_url      = wp_get_attachment_url( $attachment_id );
-            $parent_basename = wp_basename( $parent_url );
-            $url             = str_replace( $parent_basename, wp_basename( $cropped ), $parent_url );
-
-            $size       = wp_getimagesize( $cropped );
-            $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
-
-            // Get the original image's post to pre-populate the cropped image.
-            $original_attachment  = get_post( $attachment_id );
-            $sanitized_post_title = sanitize_file_name( $original_attachment->post_title );
-            $use_original_title   = (
-                ( '' !== trim( $original_attachment->post_title ) ) &&
-                /*
-                 * Check if the original image has a title other than the "filename" default,
-                 * meaning the image had a title when originally uploaded or its title was edited.
-                 */
-                ( $parent_basename !== $sanitized_post_title ) &&
-                ( pathinfo( $parent_basename, PATHINFO_FILENAME ) !== $sanitized_post_title )
-            );
-            $use_original_description = ( '' !== trim( $original_attachment->post_content ) );
-
-            $attachment = array(
-                'post_title'     => $use_original_title ? $original_attachment->post_title : wp_basename( $cropped ),
-                'post_content'   => $use_original_description ? $original_attachment->post_content : $url,
-                'post_mime_type' => $image_type,
-                'guid'           => $url,
-                'context'        => $context,
-            );
-
-            // Copy the image caption attribute (post_excerpt field) from the original image.
-            if ( '' !== trim( $original_attachment->post_excerpt ) ) {
-                $attachment['post_excerpt'] = $original_attachment->post_excerpt;
-            }
-
-            // Copy the image alt text attribute from the original image.
-            if ( '' !== trim( $original_attachment->_wp_attachment_image_alt ) ) {
-                $attachment['meta_input'] = array(
-                    '_wp_attachment_image_alt' => wp_slash( $original_attachment->_wp_attachment_image_alt ),
-                );
-            }
+            // Copy attachment properties.
+            $attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, $context );
 
             $attachment_id = wp_insert_attachment( $attachment, $cropped );

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

@@ -1078 +1078 @@
         $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
 
-        $attachment = $this->create_attachment_object( $cropped, $attachment_id );
+        $attachment =  );
 
         if ( ! empty( $_POST['create-new-attachment'] ) ) {
@@ -1315 +1315 @@
      *
      * @since 3.9.0
+
      *
      * @param string $cropped              Cropped image URL.
@@ -1321 +1322 @@
      */
     final public function create_attachment_object( $cropped, $parent_attachment_id ) {
+
         $parent     = get_post( $parent_attachment_id );
         $parent_url = wp_get_attachment_url( $parent->ID );
@@ -1422 +1424 @@
         $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
 
-        $attachment = $this->create_attachment_object( $cropped, $attachment_id );
+        $attachment =  );
 
         $previous = $this->get_previous_crop( $attachment );

trunk/src/wp-admin/includes/class-wp-site-icon.php

@@ -79 +79 @@
      *
      * @since 4.3.0
+
      *
      * @param string $cropped              Cropped image URL.
@@ -85 +86 @@
      */
     public function create_attachment_object( $cropped, $parent_attachment_id ) {
+
+
         $parent     = get_post( $parent_attachment_id );
         $parent_url = wp_get_attachment_url( $parent->ID );

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

@@ -481 +481 @@
 
     return $image_meta;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }
 

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

@@ -109 +109 @@
     }
 
-    public function test_create_attachment_object() {
-        $id = wp_insert_attachment(
-            array(
-                'post_status' => 'publish',
-                'post_title'  => 'foo.png',
-                'post_type'   => 'post',
-                'guid'        => 'http://localhost/foo.png',
-            )
-        );
-
-        $cropped = 'foo-cropped.png';
-
-        $object = $this->custom_image_header->create_attachment_object( $cropped, $id );
-        $this->assertSame( 'foo-cropped.png', $object['post_title'] );
-        $this->assertSame( 'http://localhost/' . $cropped, $object['guid'] );
-        $this->assertSame( 'custom-header', $object['context'] );
-        $this->assertSame( 'image/jpeg', $object['post_mime_type'] );
-    }
-
     public function test_insert_cropped_attachment() {
         $id = wp_insert_attachment(
@@ -139 +120 @@
 
         $cropped = 'foo-cropped.png';
-        $object  = $this->custom_image_header->create_attachment_object( $cropped, $id );
+        $object  =  );
 
         $cropped_id = $this->custom_image_header->insert_attachment( $object, $cropped );
@@ -162 +143 @@
         // Create inital crop object.
         $cropped_1 = 'foo-cropped-1.png';
-        $object    = $this->custom_image_header->create_attachment_object( $cropped_1, $id );
+        $object    =  );
 
         // Ensure no previous crop exists.
@@ -176 +157 @@
         // Create second crop.
         $cropped_2 = 'foo-cropped-2.png';
-        $object    = $this->custom_image_header->create_attachment_object( $cropped_2, $id );
+        $object    = ( $cropped_2, $id );
 
         // Test that a previous crop is found.

trunk/tests/phpunit/tests/image/siteIcon.php

@@ -99 +99 @@
     }
 
-    public function test_create_attachment_object() {
-        $attachment_id = $this->insert_attachment();
-        $parent_url    = get_post( $attachment_id )->guid;
-        $cropped       = str_replace( wp_basename( $parent_url ), 'cropped-test-image.jpg', $parent_url );
-
-        $object = $this->wp_site_icon->create_attachment_object( $cropped, $attachment_id );
-
-        $this->assertSame( $object['post_title'], 'cropped-test-image.jpg' );
-        $this->assertSame( $object['context'], 'site-icon' );
-        $this->assertSame( $object['post_mime_type'], 'image/jpeg' );
-        $this->assertSame( $object['post_content'], $cropped );
-        $this->assertSame( $object['guid'], $cropped );
-    }
-
     public function test_insert_cropped_attachment() {
         $attachment_id = $this->insert_attachment();
@@ -118 +104 @@
         $cropped       = str_replace( wp_basename( $parent_url ), 'cropped-test-image.jpg', $parent_url );
 
-        $object     = $this->wp_site_icon->create_attachment_object( $cropped, $attachment_id );
+        $object     =  );
         $cropped_id = $this->wp_site_icon->insert_attachment( $object, $cropped );