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

Timestamp:

09/18/2023 02:53:37 PM (16 months ago)

Author:

flixos90

Message:

Media: Enhance wp_get_loading_optimization_attributes() to support arbitrary context values.

The wp_get_loading_optimization_attributes() function, which was introduced in 6.3, based on the now deprecated wp_get_loading_attr_default() function introduced in 5.5, relies on a $context parameter based on which it may alter its behavior and the attributes returned. So far, it has only supported context values used within WordPress core.

This changeset decouples the behaviors of the function from specific contexts, allowing for more flexibility. Theme and plugin developers will be able to rely on their own context values when rendering images in non-standard ways, rather than being forced to use a core context, to get the loading optimization benefits the function provides.

As part of this change, a wp_loading_optimization_force_header_contexts filter is introduced, which allows filtering the map of context values and whether they should be considered header contexts, i.e. i.e. any image having one of these contexts will be assumed to appear above the fold.

Props mukesh27, costdev, flixos90.
Fixes #58894.

File:

• trunk/tests/phpunit/tests/media.php (modified) (2 diffs)

trunk/tests/phpunit/tests/media.php

@@ -4302 +4302 @@
             $this->set_main_query( $query );
 
-            /*
-             * For contexts other than for the main content, still return 'lazy' even in the loop
-             * and in the main query, and do not increase the content media count.
-             */
-            $this->assertSame(
-                array( 'loading' => 'lazy' ),
-                wp_get_loading_optimization_attributes( 'img', $attr, 'wp_get_attachment_image' )
-            );
-
             // First three element are not lazy loaded. However, first image is loaded with fetchpriority high.
             $this->assertSame(
@@ -4338 +4329 @@
             );
         }
+    }
+
+    /**
+     * Tests that wp_get_loading_optimization_attributes() returns fetchpriority=high and increases the count for arbitrary contexts in the main loop.
+     *
+     * @ticket 58894
+     *
+     * @covers ::wp_get_loading_optimization_attributes
+     *
+     * @dataProvider data_wp_get_loading_optimization_attributes_arbitrary_contexts
+     *
+     * @param string $context Context for the element for which the loading optimization attribute is requested.
+     */
+    public function test_wp_get_loading_optimization_attributes_with_arbitrary_contexts_in_main_loop( $context ) {
+        $attr = $this->get_width_height_for_high_priority();
+
+        $this->assertSame(
+            array( 'loading' => 'lazy' ),
+            wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+            'The "loading" attribute should be "lazy" when not in the loop or the main query.'
+        );
+
+        $query = $this->get_new_wp_query_for_published_post();
+
+        // Set as main query.
+        $this->set_main_query( $query );
+
+        while ( have_posts() ) {
+            the_post();
+
+            $this->assertSame(
+                array( 'fetchpriority' => 'high' ),
+                wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+                'The "fetchpriority" attribute should be "high" while in the loop and the main query.'
+            );
+
+            // Images with a certain minimum size in the arbitrary contexts of the page are also counted towards the threshold.
+            $this->assertSame( 1, wp_increase_content_media_count( 0 ), 'The content media count should be 1.' );
+        }
+    }
+
+    /**
+     * Tests that wp_get_loading_optimization_attributes() does not return lazy loading attributes when arbitrary contexts are used before the main query loop.
+     *
+     * @ticket 58894
+     *
+     * @covers ::wp_get_loading_optimization_attributes
+     *
+     * @dataProvider data_wp_get_loading_optimization_attributes_arbitrary_contexts
+     *
+     * @param string $context Context for the element for which the loading optimization attribute is requested.
+     */
+    public function test_wp_get_loading_optimization_attributes_with_arbitrary_contexts_before_main_query_loop( $context ) {
+        $attr = $this->get_width_height_for_high_priority();
+
+        $query = $this->get_new_wp_query_for_published_post();
+
+        // Set as main query.
+        $this->set_main_query( $query );
+
+        $this->assertSame(
+            array( 'loading' => 'lazy' ),
+            wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+            'The "loading" attribute should be "lazy" before the main query loop.'
+        );
+
+        while ( have_posts() ) {
+            the_post();
+
+            $this->assertSame(
+                array( 'fetchpriority' => 'high' ),
+                wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+                'The "fetchpriority" attribute should be "high" while in the loop and the main query.'
+            );
+
+            $this->assertArrayNotHasKey(
+                'loading',
+                wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+                'No "loading" attribute should be present on the second image in the main query loop.'
+            );
+        }
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[]
+     */
+    public function data_wp_get_loading_optimization_attributes_arbitrary_contexts() {
+        return array(
+            array( 'wp_get_attachment_image' ),
+            array( 'something_completely_arbitrary' ),
+        );
+    }
+
+    /**
+     * Tests that wp_get_loading_optimization_attributes() returns empty array for arbitrary context.
+     *
+     * @ticket 58894
+     *
+     * @covers ::wp_get_loading_optimization_attributes
+     */
+    public function test_wp_get_loading_optimization_attributes_should_return_empty_array_for_any_arbitrary_context() {
+        remove_all_filters( 'the_content' );
+
+        $result = null;
+        add_filter(
+            'the_content',
+            function( $content ) use ( &$result ) {
+                $attr   = $this->get_width_height_for_high_priority();
+                $result = wp_get_loading_optimization_attributes( 'img', $attr, 'something_completely_arbitrary' );
+                return $content;
+            }
+        );
+        apply_filters( 'the_content', '' );
+
+        $this->assertSame( array(), $result );
+    }
+
+    /**
+     * @ticket 58894
+     *
+     * @covers ::wp_get_loading_optimization_attributes
+     *
+     * @dataProvider data_wp_get_loading_optimization_attributes_header_context
+     *
+     * @param string $context The context for the header.
+     */
+    public function test_wp_get_loading_optimization_attributes_header_contexts( $context ) {
+        $attr = $this->get_width_height_for_high_priority();
+
+        $this->assertArrayNotHasKey(
+            'loading',
+            wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+            'Images in the header context should not be lazy-loaded.'
+        );
+
+        add_filter( 'wp_loading_optimization_force_header_contexts', '__return_empty_array' );
+
+        $this->assertSame(
+            array( 'loading' => 'lazy' ),
+            wp_get_loading_optimization_attributes( 'img', $attr, $context ),
+            'Images in the header context should get lazy-loaded after the wp_loading_optimization_force_header_contexts filter.'
+        );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[]
+     */
+    public function data_wp_get_loading_optimization_attributes_header_context() {
+        return array(
+            array( 'template_part_' . WP_TEMPLATE_PART_AREA_HEADER ),
+            array( 'get_header_image_tag' ),
+        );
+    }
+
+    /**
+     * @ticket 58894
+     *
+     * @covers ::wp_get_loading_optimization_attributes
+     */
+    public function test_wp_loading_optimization_force_header_contexts_filter() {
+        $attr = $this->get_width_height_for_high_priority();
+
+        add_filter(
+            'wp_loading_optimization_force_header_contexts',
+            function( $context ) {
+                $contexts['something_completely_arbitrary'] = true;
+                return $contexts;
+            }
+        );
+
+        $this->assertSame(
+            array( 'fetchpriority' => 'high' ),
+            wp_get_loading_optimization_attributes( 'img', $attr, 'something_completely_arbitrary' )
+        );
     }