Skip to content

Increase default for wp_omit_loading_attr_threshold to 3 #4428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

Increase default for wp_omit_loading_attr_threshold to 3 #4428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
012df11
change default to 3 for wp_omit_loading_attr_threshold
kt-12 May 4, 2023
57f92c4
logic update asper the new default.
kt-12 May 4, 2023
8e8eda4
change default
kt-12 May 4, 2023
6985503
add since for the new change
kt-12 May 12, 2023
15df68b
grammar fix
kt-12 May 12, 2023
9561247
add filter to change threshold
kt-12 May 12, 2023
4156837
Merge branch 'enhancement/58213' of https://github.com/10up/wordpress…
kt-12 May 12, 2023
b94ed4d
change closure to a common method.
kt-12 May 16, 2023
112643f
add message to assertion and also avoid loop
kt-12 May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/wp-includes/media.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5434,7 +5434,7 @@ function wp_get_webp_info( $filename ) {
*
* Under the hood, the function uses {@see wp_increase_content_media_count()} every time it is called for an element
* within the main content. If the element is the very first content element, the `loading` attribute will be omitted.
* This default threshold of 1 content element to omit the `loading` attribute for can be customized using the
* This default threshold of 3 content elements to omit the `loading` attribute for can be customized using the
* {@see 'wp_omit_loading_attr_threshold'} filter.
*
* @since 5.9.0
Expand Down Expand Up @@ -5484,7 +5484,7 @@ function wp_get_loading_attr_default( $context ) {
/**
* Gets the threshold for how many of the first content media elements to not lazy-load.
*
* This function runs the {@see 'wp_omit_loading_attr_threshold'} filter, which uses a default threshold value of 1.
* This function runs the {@see 'wp_omit_loading_attr_threshold'} filter, which uses a default threshold value of 3.
* The filter is only run once per page load, unless the `$force` parameter is used.
*
* @since 5.9.0
Expand All @@ -5505,10 +5505,11 @@ function wp_omit_loading_attr_threshold( $force = false ) {
* for only the very first content media element.
*
* @since 5.9.0
* @since 6.3.0 The default threshold was changed from 1 to 3.
*
* @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 1.
* @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 3.
*/
$omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 1 );
$omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 3 );
}

return $omit_threshold;
Expand Down
61 changes: 32 additions & 29 deletions tests/phpunit/tests/media.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3585,8 +3585,10 @@ public function test_wp_get_loading_attr_default( $context ) {
// and in the main query, and do not increase the content media count.
$this->assertSame( 'lazy', wp_get_loading_attr_default( 'wp_get_attachment_image' ) );

// Return `false` if in the loop and in the main query and it is the first element.
$this->assertFalse( wp_get_loading_attr_default( $context ) );
// Return `false` in the main query for first three element.
$this->assertFalse( wp_get_loading_attr_default( $context ), 'Expected first image to not be lazy-loaded.' );
$this->assertFalse( wp_get_loading_attr_default( $context ), 'Expected second image to not be lazy-loaded.' );
$this->assertFalse( wp_get_loading_attr_default( $context ), 'Expected third image to not be lazy-loaded.' );

// Return 'lazy' if in the loop and in the main query for any subsequent elements.
$this->assertSame( 'lazy', wp_get_loading_attr_default( $context ) );
Expand Down Expand Up @@ -3618,19 +3620,14 @@ public function test_wp_omit_loading_attr_threshold_filter() {
$this->reset_content_media_count();
$this->reset_omit_loading_attr_filter();

// Use the filter to alter the threshold for not lazy-loading to the first three elements.
add_filter(
'wp_omit_loading_attr_threshold',
function() {
return 3;
}
);
// Use the filter to alter the threshold for not lazy-loading to the first five elements.
$this->force_omit_loading_attr_threshold( 5 );

while ( have_posts() ) {
the_post();

// Due to the filter, now the first three elements should not be lazy-loaded, i.e. return `false`.
for ( $i = 0; $i < 3; $i++ ) {
// Due to the filter, now the first five elements should not be lazy-loaded, i.e. return `false`.
for ( $i = 0; $i < 5; $i++ ) {
$this->assertFalse( wp_get_loading_attr_default( 'the_content' ) );
}

Expand All @@ -3655,12 +3652,7 @@ public function test_wp_filter_content_tags_with_wp_get_loading_attr_default() {
$lazy_iframe2 = wp_iframe_tag_add_loading_attr( $iframe2, 'the_content' );

// Use a threshold of 2.
add_filter(
'wp_omit_loading_attr_threshold',
function() {
return 2;
}
);
$this->force_omit_loading_attr_threshold( 2 );

// Following the threshold of 2, the first two content media elements should not be lazy-loaded.
$content_unfiltered = $img1 . $iframe1 . $img2 . $img3 . $iframe2;
Expand Down Expand Up @@ -3690,24 +3682,20 @@ function() {
public function test_wp_omit_loading_attr_threshold() {
$this->reset_omit_loading_attr_filter();

// Apply filter, ensure default value of 1.
// Apply filter, ensure default value of 3.
$omit_threshold = wp_omit_loading_attr_threshold();
$this->assertSame( 1, $omit_threshold );
$this->assertSame( 3, $omit_threshold );

// Add a filter that changes the value to 1. However, the filter is not applied a subsequent time in a single
// page load by default, so the value is still 3.
$this->force_omit_loading_attr_threshold( 1 );

// Add a filter that changes the value to 3. However, the filter is not applied a subsequent time in a single
// page load by default, so the value is still 1.
add_filter(
'wp_omit_loading_attr_threshold',
function() {
return 3;
}
);
$omit_threshold = wp_omit_loading_attr_threshold();
$this->assertSame( 1, $omit_threshold );
$this->assertSame( 3, $omit_threshold );

// Only by enforcing a fresh check, the filter gets re-applied.
$omit_threshold = wp_omit_loading_attr_threshold( true );
$this->assertSame( 3, $omit_threshold );
$this->assertSame( 1, $omit_threshold );
}

/**
Expand All @@ -3725,6 +3713,7 @@ public function test_wp_filter_content_tags_does_not_lazy_load_first_image_in_bl
// Do not add srcset, sizes, or decoding attributes as they are irrelevant for this test.
add_filter( 'wp_img_tag_add_srcset_and_sizes_attr', '__return_false' );
add_filter( 'wp_img_tag_add_decoding_attr', '__return_false' );
$this->force_omit_loading_attr_threshold( 1 );

$img1 = get_image_tag( self::$large_id, '', '', '', 'large' );
$img2 = get_image_tag( self::$large_id, '', '', '', 'medium' );
Expand Down Expand Up @@ -3777,6 +3766,7 @@ function( $attr ) {
return $attr;
}
);
$this->force_omit_loading_attr_threshold( 1 );

$content_img = get_image_tag( self::$large_id, '', '', '', 'large' );
$lazy_content_img = wp_img_tag_add_loading_attr( $content_img, 'the_content' );
Expand Down Expand Up @@ -4012,6 +4002,19 @@ public function image_editor_change_quality_low_jpeg( $quality, $mime_type ) {
}
}

/**
* Change the omit loading attribute threshold value.
*
* @param int $threshold Threshold value to change.
*/
public function force_omit_loading_attr_threshold( $threshold ) {
add_filter(
'wp_omit_loading_attr_threshold',
static function() use ( $threshold ) {
return $threshold;
}
);
}
}

/**
Expand Down