Query Loop: Remove is_singular() check and fix test #65483

mikachan · 2024-09-19T10:10:13Z

What?

This is a follow-up to #65067 to improve the implementation of querying 'post' post types.

Why?

As inherit is now automatically set to false when a Query Loop is inserted within content (a single post/page/CPT), we don't need to manually update the query in an is_singular() check.

Also, query_posts() should generally be avoided as it could cause some unwanted side effects. See this comment for more details.

How?

Removes the is_singular() check from the Post Template server-side render, and updates the test_rendering_post_template_with_main_query_loop_already_started test so that it is correctly using inherit: false in the test block markup.

Testing Instructions

Insert a query loop block in a singular page/post/CPT
Ensure that it defaults to displaying posts in both the Editor and front-end
Ensure that the post type can be changed in the Editor and, if customised, that it shows the custom query on the front-end
Ensure the test_rendering_post_template_with_main_query_loop_already_started PHP unit test passes

github-actions · 2024-09-19T10:10:33Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: mikachan <mikachan@git.wordpress.org>
Co-authored-by: jffng <jffng@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

… test

jffng

The change makes sense to me and still works as described in the original PR. I just have a question about the test.

jffng · 2024-09-19T20:35:48Z

phpunit/blocks/render-post-template-test.php

@@ -122,7 +122,7 @@ public function test_rendering_post_template_with_main_query_loop_already_starte
 		global $wp_query, $wp_the_query;

 		// Query block with post template block.
-		$content  = '<!-- wp:query {"query":{"inherit":true}} -->';


Why does this test need to change? Was this not testing with the correct inherit setting before?

Was this not testing with the correct inherit setting before?

No 🙈 And it was passing because I was using query_posts(), which I think was replacing the global query, so anything set via the Query Loop block was ignored and wasn't truly being tested.

This test should have been updated when the changes were added for automatically setting inherit to false in the original PR. It was a complete oversight by me, although I'm glad I updated the test earlier on in the process and so I knew how to fix it. 😅

I see! Good thing you caught it early.

mikachan · 2024-09-20T09:13:11Z

Thanks for taking a look, @jffng! With @dlh01's help, I noticed that we no longer need the is_singular() check in the server-side rendering of the Post Template. It looks like setting inherit to false when within singular content was the only change needed.

I've updated the PR to include this change, and we also need the fix for the test so it's testing with the correct markup (inherit: false).

This is ready for another review 🙏

* Replace query_posts() with set() * Fix test_rendering_post_template_with_main_query_loop_already_started test * Remove is_singular check Co-authored-by: mikachan <mikachan@git.wordpress.org> Co-authored-by: jffng <jffng@git.wordpress.org> Co-authored-by: David Herrera <697432+dlh01@users.noreply.github.com>

github-actions · 2024-09-20T16:52:01Z

I just cherry-picked this PR to the wp/6.7 branch to get it included in the next release: 3215aa5

* Replace query_posts() with set() * Fix test_rendering_post_template_with_main_query_loop_already_started test * Remove is_singular check Co-authored-by: mikachan <mikachan@git.wordpress.org> Co-authored-by: jffng <jffng@git.wordpress.org> Co-authored-by: David Herrera <697432+dlh01@users.noreply.github.com>

kevin940726 · 2024-09-23T02:13:17Z

I just cherry-picked this PR to the release/19.3 branch to get it included in the next release: f731ae7

Replace query_posts() with set()

ae28205

mikachan self-assigned this Sep 19, 2024

mikachan requested a review from ajitbohra as a code owner September 19, 2024 10:10

mikachan mentioned this pull request Sep 19, 2024

Query Loop: Default to querying posts when on singular content #65067

Merged

Fix test_rendering_post_template_with_main_query_loop_already_started…

b858a15

… test

jffng reviewed Sep 19, 2024

View reviewed changes

Remove is_singular check

b4a347b

mikachan changed the title ~~Query Loop: Improve post query implementation~~ Query Loop: Remove is_singular() check and fix test Sep 20, 2024

jffng approved these changes Sep 20, 2024

View reviewed changes

mikachan merged commit b1d9255 into trunk Sep 20, 2024
63 checks passed

mikachan deleted the update/query-loop-alter-query branch September 20, 2024 16:50

github-actions bot added this to the Gutenberg 19.4 milestone Sep 20, 2024

github-actions bot removed the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Sep 20, 2024

github-actions bot added the Backported to WP Core Pull request that has been successfully merged into WP Core label Sep 20, 2024

kevin940726 removed the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Sep 23, 2024

kevin940726 modified the milestones: Gutenberg 19.4, Gutenberg 19.3 Sep 23, 2024

noisysocks mentioned this pull request Sep 23, 2024

Update packages for 6.7 Beta 1 (2/3) WordPress/wordpress-develop#7417

Closed

This was referenced Sep 26, 2024

[Snyk] Upgrade @wordpress/data from 6.6.2 to 10.7.0 WontonSam/chicommerce#653

Open

[Snyk] Upgrade @wordpress/data from 6.6.2 to 10.7.0 WontonSam/chicommerce#667

Open

draganescu mentioned this pull request Oct 15, 2024

Manual cherry pick for #65627 #66119

Merged

sirreal mentioned this pull request Oct 25, 2024

test/pr automation workflow #66457

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Query Loop: Remove is_singular() check and fix test #65483

Query Loop: Remove is_singular() check and fix test #65483

mikachan commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024 •

edited

Loading

jffng left a comment •

edited

Loading

jffng Sep 19, 2024

mikachan Sep 20, 2024

jffng Sep 20, 2024

mikachan commented Sep 20, 2024

github-actions bot commented Sep 20, 2024

kevin940726 commented Sep 23, 2024

Query Loop: Remove is_singular() check and fix test #65483

Query Loop: Remove is_singular() check and fix test #65483

Conversation

mikachan commented Sep 19, 2024 • edited Loading

What?

Why?

How?

Testing Instructions

github-actions bot commented Sep 19, 2024 • edited Loading

jffng left a comment • edited Loading

Choose a reason for hiding this comment

jffng Sep 19, 2024

Choose a reason for hiding this comment

mikachan Sep 20, 2024

Choose a reason for hiding this comment

jffng Sep 20, 2024

Choose a reason for hiding this comment

mikachan commented Sep 20, 2024

github-actions bot commented Sep 20, 2024

kevin940726 commented Sep 23, 2024

mikachan commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024 •

edited

Loading

jffng left a comment •

edited

Loading