Changeset 38296

Timestamp:

08/21/2016 06:14:37 AM (8 years ago)

Author:

wonderboymusic

Message:

Media: use wp_get_attachment_metadata() instead of get_post_meta() where appropriate.

Adds unit test.

Props JorritSchippers.
Fixes #36246.

Location:

trunk

Files:

• src/wp-includes/media.php (modified) (5 diffs)
• tests/phpunit/tests/media.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -862 +862 @@
         // Generate 'srcset' and 'sizes' if not already present.
         if ( empty( $attr['srcset'] ) ) {
-            $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
+            $image_meta = wp_get_attachment_metadata( $attachment_id );
 
             if ( is_array( $image_meta ) ) {
@@ -991 +991 @@
 
     if ( ! is_array( $image_meta ) ) {
-        $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
+        $image_meta = wp_get_attachment_metadata( $attachment_id );
     }
 
@@ -1207 +1207 @@
 
     if ( ! is_array( $image_meta ) ) {
-        $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
+        $image_meta = wp_get_attachment_metadata( $attachment_id );
     }
 
@@ -1240 +1240 @@
     } elseif ( is_string( $size ) ) {
         if ( ! $image_meta && $attachment_id ) {
-            $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
+            $image_meta = wp_get_attachment_metadata( $attachment_id );
         }
 
@@ -1315 +1315 @@
 
     foreach ( $selected_images as $image => $attachment_id ) {
-        $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
+        $image_meta = wp_get_attachment_metadata( $attachment_id );
         $content = str_replace( $image, wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ), $content );
     }

trunk/tests/phpunit/tests/media.php

@@ -1756 +1756 @@
         $this->assertSame( $expected, get_image_send_to_editor( $id, $caption, $title, $align, $url, $rel, $size, $alt ) );
     }
+
+    /**
+     * Tests if wp_get_attachment_image() uses wp_get_attachment_metadata().
+     *
+     * In this way, the meta data can be filtered using the filter
+     * `wp_get_attachment_metadata`.
+     *
+     * The test checks if the image size that is added in the filter is
+     * used in the output of `wp_get_attachment_image()`.
+     *
+     * @ticket 36246
+     */
+    function test_wp_get_attachment_image_should_use_wp_get_attachment_metadata() {
+        add_filter( 'wp_get_attachment_metadata', array( $this, '_filter_36246' ), 10, 2 );
+
+        $actual = wp_get_attachment_image( self::$large_id, 'testsize' );
+        $expected = '<img width="999" height="999" src="http://example.org/wp-content/uploads/2016/03/test-image-testsize-999x999.png" class="attachment-testsize size-testsize" alt="test-image-large.png" srcset="http://example.org/wp-content/uploads/2016/03/test-image-large-150x150.png 150w, http://example.org/wp-content/uploads/2016/03/test-image-testsize-999x999.png 999w" sizes="(max-width: 999px) 100vw, 999px" />';
+
+        remove_filter( 'wp_get_attachment_metadata', array( $this, '_filter_36246' ) );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    function _filter_36246( $data, $attachment_id ) {
+        $data['sizes']['testsize'] = array(
+            'file' => 'test-image-testsize-999x999.png',
+            'width' => 999,
+            'height' => 999,
+            'mime-type' => 'image/png',
+        );
+        return $data;
+    }
 }