Changeset 49234

Timestamp:

10/20/2020 03:29:42 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Media: Introduce a filter for wp_get_attachment_image() HTML output.

Props prionkor, antpb, donmhico, audrasjb, Mista-Flo, hellofromTonya.
Fixes #50801.

Location:

trunk

Files:

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

trunk/src/wp-includes/media.php

@@ -993 +993 @@
 
 /**
- * Get an HTML img element representing an image attachment
+ * Get an HTML img element representing an image attachment.
  *
  * While `$size` will accept an array, it is better to register a size with
@@ -1100 +1100 @@
     }
 
-    return $html;
+    /**
+     * HTML img element representing an image attachment.
+     *
+     * @since 5.6.0
+     *
+     * @param string       $html          HTML img element or empty string on failure.
+     * @param int          $attachment_id Image attachment ID.
+     * @param string|int[] $size          Requested image size. Can be any registered image size name, or
+     *                                    an array of width and height values in pixels (in that order).
+     * @param bool         $icon          Whether the image should be treated as an icon.
+     * @param array        $attr          Array of attribute values for the image markup, keyed by attribute name.
+     *                                    See wp_get_attachment_image().
+     */
+    return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );
 }
 

trunk/tests/phpunit/tests/media.php

@@ -1342 +1342 @@
 
         $this->assertSame( $expected, wp_get_attachment_image( self::$large_id ) );
+    }
+
+    /**
+     * @ticket 50801
+     */
+    function test_wp_get_attachment_image_filter_output() {
+        $image    = image_downsize( self::$large_id, 'thumbnail' );
+        $expected = 'Override wp_get_attachment_image';
+
+        add_filter( 'wp_get_attachment_image', array( $this, 'filter_wp_get_attachment_image' ) );
+        $output = wp_get_attachment_image( self::$large_id );
+        remove_filter( 'wp_get_attachment_image', array( $this, 'filter_wp_get_attachment_image' ) );
+
+        $this->assertSame( $expected, $output );
+    }
+
+    function filter_wp_get_attachment_image() {
+        return 'Override wp_get_attachment_image';
     }