Changeset 55821 for trunk/tests/phpunit/tests/media.php

Timestamp:

05/17/2023 06:29:41 PM (3 years ago)

Author:

flixos90

Message:

Media: Introduce wp_get_attachment_image_context filter.

Since WordPress 5.9, a "context" value of "wp_get_attachment_image" has been used in the wp_get_attachment_image() function to provide context to underlying functions where that is relevant, e.g. wp_get_loading_attr_default(). Since that value used to be not customizable, it required a workaround in get_the_post_thumbnail() to avoid calling those functions in wp_get_attachment_image(), which resulted in unnecessary complexity and was prone to errors.

This changeset introduces a wp_get_attachment_image_context filter and leverages it with private filter callback functions that are leveraged by default when get_the_post_thumbnail() is called. This avoids the need for the previous workaround and furthermore provides flexibility for other callers of wp_get_attachment_image() to provide their own contexts.

Props flixos90, costdev, thekt12, westonruter, spacedmonkey.
Fixes #58212.

File:

• trunk/tests/phpunit/tests/media.php (modified) (1 diff)

trunk/tests/phpunit/tests/media.php

@@ -3965 +3965 @@
 
     /**
+     * Tests that `wp_get_attachment_image()` uses the correct default context.
+     *
+     * @ticket 58212
+     *
+     * @covers ::wp_get_attachment_image()
+     */
+    public function test_wp_get_attachment_image_context_filter_default() {
+        $last_context = '';
+        $this->track_last_attachment_image_context( $last_context );
+
+        wp_get_attachment_image( self::$large_id );
+        $this->assertSame( 'wp_get_attachment_image', $last_context );
+    }
+
+    /**
+     * Tests that `wp_get_attachment_image()` allows overriding the context via filter.
+     *
+     * @ticket 58212
+     *
+     * @covers ::wp_get_attachment_image()
+     */
+    public function test_wp_get_attachment_image_context_filter_value_is_passed_correctly() {
+        $last_context = '';
+        $this->track_last_attachment_image_context( $last_context );
+
+        // Add a filter that modifies the context.
+        add_filter(
+            'wp_get_attachment_image_context',
+            static function() {
+                return 'my_custom_context';
+            }
+        );
+
+        wp_get_attachment_image( self::$large_id );
+        $this->assertSame( 'my_custom_context', $last_context );
+    }
+
+    /**
+     * Helper method to keep track of the last context returned by the 'wp_get_attachment_image_context' filter.
+     *
+     * The method parameter is passed by reference and therefore will always contain the last context value.
+     *
+     * @param mixed $last_context Variable to track last context. Passed by reference.
+     */
+    private function track_last_attachment_image_context( &$last_context ) {
+        add_filter(
+            'wp_get_attachment_image_context',
+            static function( $context ) use ( &$last_context ) {
+                $last_context = $context;
+                return $context;
+            },
+            11
+        );
+    }
+
+    /**
      * Add threshold to create a `-scaled` output image for testing.
      */