Ensure post-featured-image block is in_the_loop() for BC with core and plugins, and to fix lazy-loading #45534

felixarntz · 2022-11-03T22:31:45Z

What?

This PR is part of the solution from WordPress/wordpress-develop#3560 (see that PR for additional context), which addresses https://core.trac.wordpress.org/ticket/56930. The problem here specifically also addresses #41783.

Why?

Currently the logic to not lazy-load the first featured image or in-content image is not working for block themes. WordPress/wordpress-develop#3560 is the full solution to that problem, however this PR here is necessary since the block itself comes from Gutenberg. We should therefore merge and port this to WP core's blocks soon (in time for WP 6.2).

How?

WP core's logic to determine whether to lazy-load an image expects to run in_the_loop() when the main content is rendered. Since block themes by default may not enter the loop initially, this extra call here needs to be added, as currently the lack of it is a backward compatibility break causing the problem outlined above. This fix is already present in the post-content block, so it's simply brought over here as well.

Testing Instructions

Test this as part of Ensure that first content image is not lazy-loaded in block themes either wordpress-develop#3560 as by itself here it is not going to solve the entire problem.
Use a block theme and view a post with a featured image in the frontend.
With WordPress trunk, the first featured image will have loading="lazy" on it, which is incorrect. With Ensure that first content image is not lazy-loaded in block themes either wordpress-develop#3560, it will not have the attribute as expected.

…d plugins.

codesandbox · 2022-11-03T22:31:48Z

Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

packages/block-library/src/post-featured-image/index.php

felixarntz · 2022-11-14T18:15:00Z

@Mamaduka I'd like to get this on your radar. Can we prioritize this PR for an upcoming Gutenberg release and then a merge to WP core trunk, to unblock https://core.trac.wordpress.org/ticket/56930 and WordPress/wordpress-develop#3560, which are scheduled for WP 6.2?

Mamaduka · 2022-11-15T12:14:37Z

Thanks for the ping, @felixarntz!

This is on my to-do list, and I will try to test it as soon as possible thoroughly.

Mamaduka

The changes test well for me, and considering we already have similar code in the Post Content block for BC, I think this is safe to land.

Tests

I confirmed that thumbnail previews work as before.
The first featured image doesn't have the loading="lazy" attribute when testing with Ensure that first content image is not lazy-loaded in block themes either wordpress-develop#3560.

A follow-up

We'll need a similar follow-up for the Cover block when it renders the featured image, but this doesn't have to be a blocker for WordPress/wordpress-develop#3560.

Mamaduka · 2022-11-16T11:26:16Z

packages/block-library/src/post-featured-image/index.php

+	if ( ! in_the_loop() && have_posts() ) {
+		the_post();
+	}
+
 	$is_link        = isset( $attributes['isLink'] ) && $attributes['isLink'];
 	$size_slug      = isset( $attributes['sizeSlug'] ) ? $attributes['sizeSlug'] : 'post-thumbnail';
 	$post_title     = trim( strip_tags( get_the_title( $post_ID ) ) );


Should we remove the $post_ID usage from the context now that we set the global post object? I think we did something similar in #37622.

@Mamaduka Oh you mean not pass $post_ID to these functions and instead rely on the default which would be the same current post anyway? That seems reasonable to me.

We could do this here and also further down on get_the_post_thumbnail() and get_the_permalink().

Do you think I should add it to this PR or rather in a separate PR?

Oh you mean not pass $post_ID to these functions and instead rely on the default which would be the same current post anyway? That seems reasonable to me.
We could do this here and also further down on get_the_post_thumbnail() and get_the_permalink().

Correct.

Do you think I should add it to this PR or rather in a separate PR?

We can do it in a separate PR if you prefer.

@Mamaduka Sounds good, I'll open a follow up PR once this is merged. Is this waiting for anything else or should we merge it?

Feel free to merge 👍

Yeah, that's the main reason I'm asking. Is there any way we can cherry-pick / backport this change to core sooner? Happy to help as much as I can.

We'll have to do a minor release for the packages outside the release scope, but I don't know what's the policy here. I'm going to ping folks who have done more release than me.

Cc. @noisysocks, @youknowriad

We'll have to do a minor release for the packages outside the release scope, but I don't know what's the policy here. I'm going to ping folks who have done more release than me.

This is something we do often I think. We'll have to cherry-pick the commits to the right wp/* branch and perform a npm patch release from there. I'm not entirely certain with the process (as it changed lately a bit) but I know that it's documented.

Thanks, Riad! I'm familiar with the new process and can do a patch release.

@felixarntz, I can do a package release and prepare core PR early next week.

Perfect, thanks both! Let me know if I can help with anything like reviews or so.

…d plugins. (#45534)

Fixing the issue that featured images are always lazy-loaded in block themes required an upstream Gutenberg change WordPress/gutenberg#45534. This changeset updates packages in order to unblock the remainder of the fix in `trunk`. Props mamaduka. See #56930. git-svn-id: https://develop.svn.wordpress.org/trunk@55079 602fd350-edb4-49c9-b593-d223f7449a82

Fixing the issue that featured images are always lazy-loaded in block themes required an upstream Gutenberg change WordPress/gutenberg#45534. This changeset updates packages in order to unblock the remainder of the fix in `trunk`. Props mamaduka. See #56930. Built from https://develop.svn.wordpress.org/trunk@55079 git-svn-id: http://core.svn.wordpress.org/trunk@54612 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Fixing the issue that featured images are always lazy-loaded in block themes required an upstream Gutenberg change WordPress/gutenberg#45534. This changeset updates packages in order to unblock the remainder of the fix in `trunk`. Props mamaduka. See #56930. Built from https://develop.svn.wordpress.org/trunk@55079 git-svn-id: https://core.svn.wordpress.org/trunk@54612 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Fixing the issue that featured images are always lazy-loaded in block themes required an upstream Gutenberg change WordPress/gutenberg#45534. This changeset updates packages in order to unblock the remainder of the fix in `trunk`. Props mamaduka. See #56930. Built from https://develop.svn.wordpress.org/trunk@55079 git-svn-id: http://core.svn.wordpress.org/trunk@54612 1a063a9b-81f0-0310-95a4-ce76da25c4cd

tomusborne · 2023-03-30T16:06:33Z

@felixarntz Just a heads up that this PR seems to have broken the core loop if the Post Featured Image block is hooked before it: https://core.trac.wordpress.org/ticket/58027

felixarntz · 2023-03-30T16:11:55Z

@tomusborne Thank you, looking into it!

Ensure post-featured-image block is in_the_loop() for BC with core an…

addbe8f

…d plugins.

felixarntz requested a review from ajitbohra as a code owner November 3, 2022 22:31

felixarntz mentioned this pull request Nov 3, 2022

Ensure that first content image is not lazy-loaded in block themes either WordPress/wordpress-develop#3560

Closed

felixarntz requested review from adamsilverstein and aristath November 3, 2022 22:33

felixarntz changed the title ~~Ensure post-featured-image block is in_the_loop() for BC with core and plugins~~ Ensure post-featured-image block is in_the_loop() for BC with core and plugins, and to fix lazy-loading Nov 3, 2022

adamsilverstein reviewed Nov 10, 2022

View reviewed changes

packages/block-library/src/post-featured-image/index.php Show resolved Hide resolved

felixarntz requested a review from Mamaduka November 14, 2022 18:13

Mamaduka approved these changes Nov 16, 2022

View reviewed changes

aristath approved these changes Nov 16, 2022

View reviewed changes

felixarntz merged commit 799c416 into trunk Nov 16, 2022

felixarntz deleted the fix/41783-post-featured-image-bc-break branch November 16, 2022 20:51

github-actions bot added this to the Gutenberg 14.7 milestone Nov 16, 2022

This was referenced Nov 16, 2022

Do not unnecessarily pass post ID to various query loop aware functions #45828

Open

wp-block-post-featured-image missing the lazy attribute #41783

Closed

Mamaduka pushed a commit that referenced this pull request Nov 29, 2022

Ensure post-featured-image block is in_the_loop() for BC with core an…

287d6e1

…d plugins. (#45534)

Mamaduka mentioned this pull request Nov 29, 2022

Cherry-pick changes for packages' minor release #46154

Merged

Mamaduka pushed a commit that referenced this pull request Nov 29, 2022

Ensure post-featured-image block is in_the_loop() for BC with core an…

17b85a8

…d plugins. (#45534)

felixarntz mentioned this pull request Jan 16, 2023

Parse (area-specific) context in template-part block. #47203

Merged

felixarntz mentioned this pull request Aug 28, 2023

Fix query loop bugs by correctly relying on the main query and removing problematic workaround #49904

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure post-featured-image block is in_the_loop() for BC with core and plugins, and to fix lazy-loading #45534

Ensure post-featured-image block is in_the_loop() for BC with core and plugins, and to fix lazy-loading #45534

felixarntz commented Nov 3, 2022

codesandbox bot commented Nov 3, 2022

felixarntz commented Nov 14, 2022

Mamaduka commented Nov 15, 2022

Mamaduka left a comment

Mamaduka Nov 16, 2022

felixarntz Nov 16, 2022 •

edited

Loading

Mamaduka Nov 16, 2022

felixarntz Nov 16, 2022

Mamaduka Nov 16, 2022

felixarntz Nov 17, 2022

Mamaduka Nov 17, 2022

youknowriad Nov 18, 2022

Mamaduka Nov 18, 2022

felixarntz Nov 18, 2022

tomusborne commented Mar 30, 2023

felixarntz commented Mar 30, 2023

Ensure post-featured-image block is in_the_loop() for BC with core and plugins, and to fix lazy-loading #45534

Ensure post-featured-image block is in_the_loop() for BC with core and plugins, and to fix lazy-loading #45534

Conversation

felixarntz commented Nov 3, 2022

What?

Why?

How?

Testing Instructions

codesandbox bot commented Nov 3, 2022

felixarntz commented Nov 14, 2022

Mamaduka commented Nov 15, 2022

Mamaduka left a comment

Choose a reason for hiding this comment

Tests

A follow-up

Choose a reason for hiding this comment

felixarntz Nov 16, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomusborne commented Mar 30, 2023

felixarntz commented Mar 30, 2023

felixarntz Nov 16, 2022 •

edited

Loading