Add `Ignore` option to sticky options for Query Loop block #66222

coreyworrell · 2024-10-17T18:48:48Z

What?

Query block sticky posts needs "Ignore" option

Why?

Currently there are options:

Include: default behavior where sticky posts are prepended to returned posts
Exclude: all sticky posts are excluded
Only: only sticky posts are included

There should be a final option:

Ignore: sticky posts are included in their natural order (basically as if they were not sticky)

This would simply set 'ignore_sticky_posts' => true in the query.

This is very useful for building a "Recent posts" list where we just want most recent regardless of sticky or not.

How?

It adds an Ignore option for user to select and then sets the query var to ignore sticky posts.

Testing Instructions

Create a new post, or set existing post as Sticky
Edit a page or template
Insert a Query Loop block
Uncheck Inherit query from template
For Sticky Posts, select Ignore option
See sticky posts in natural sorting order

Testing Instructions for Keyboard

Screenshots or screencast

github-actions · 2024-10-17T18:49:07Z

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: coreyworrell <[email protected]>
Co-authored-by: draganescu <[email protected]>
Co-authored-by: carolinan <[email protected]>
Co-authored-by: ntsekouras <[email protected]>
Co-authored-by: jameskoster <[email protected]>

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

coreyworrell · 2024-10-17T18:55:02Z

See WordPress/wordpress-develop#7584 and https://core.trac.wordpress.org/ticket/62247

carolinan · 2024-10-23T11:48:36Z

Hi @coreyworrell Please complete the sections in the pull request description: Why, how, and testing instructions.

You need to to add a temporary compatibility function to Gutenberg that updates build_query_vars_from_query_block.
It is not enough to only update it in WordPress core since that would prevent the feature from being tested without the development version of WordPress.

Please see the examples in https://github.com/WordPress/gutenberg/tree/trunk/lib/compat/wordpress-6.7

coreyworrell · 2024-10-24T17:09:30Z

@carolinan Thank you, I have updated the description and added the compat code just now.

carolinan · 2024-10-28T08:45:30Z

The changes work well in my test.

To me it makes sense to support ignore_sticky_posts in the query loop block but a final decision needs to be made. @WordPress/gutenberg-core
I don't recall why it was not included when the other sticky post options were added.

I would like to make the following change requests:
The help text "Sticky posts always appear first, regardless of their publish date." is not accurate when this option is selected, and needs to be adjusted conditionally.
The coding standard errors need to be fixed and the backporting changelog needs to be added.
The PHP change needs to be added to a 6.8 compatibility folder, since no more enhancements can be made to 6.7.

draganescu

I think the idea here is good. Left some comments as to the state of the PR.

draganescu · 2024-10-28T11:23:10Z

lib/compat/wordpress-6.7/blocks.php

+		// core function.
+		$sticky = get_option( 'sticky_posts' );
+
+		$query['post__not_in'] = array_diff( $query['post__not_in'], ! empty( $sticky ) ? $sticky : array() );


Why do we exlude sticky posts? Ignore set below should include them and just list them in their natural order, right?

Line 125 doesn't exclude them, it's actually re-including them after core already excluded them. That's what the comment above line 123 is about.

draganescu · 2024-10-28T11:23:24Z

lib/compat/wordpress-6.7/blocks.php

+
+/**
+ * Adds `ignore` option for sticky posts to the Query block.
+ * 


The linting has to be addressed.

draganescu · 2024-10-28T11:24:18Z

packages/block-library/src/query/edit/inspector-controls/sticky-control.js

@@ -8,6 +8,7 @@ const stickyOptions = [
 	{ label: __( 'Include' ), value: '' },
 	{ label: __( 'Exclude' ), value: 'exclude' },
 	{ label: __( 'Only' ), value: 'only' },
+	{ label: __( 'Ignore' ), value: 'ignore' },


How does this affect the editor? Shouldn't there be some change to the querying done clientside in the editor too?

Great question.

In the editor, the sticky posts are already bugged on trunk. For example sticky posts do not show as the first posts when the "include" option is set, which is the default. The result in the editor and front already does not match.

We should at least try to see if we can match the preview in editor. As @carolinan says it's already buggy and if I remember correctly is about what REST API supports how it maps with WP_Query. That's probably the reason (the mapping) for not having this as a separate option for sticky control.

coreyworrell · 2024-10-29T23:53:34Z

Edit: I was able to add the backport

@carolinan

The coding standard errors need to be fixed and the backporting changelog needs to be added. The PHP change needs to be added to a 6.8 compatibility folder, since no more enhancements can be made to 6.7.

Are you able to help with the backporting changelog, I'm not familiar with that process? Thanks very much.

lib/compat/wordpress-6.7/blocks.php

ntsekouras · 2024-11-01T13:12:01Z

Thanks for the PR! It's been a while, but I think the reason for not having this option initially was about what REST API supports how it maps with WP_Query. It might just have also been an oversight.

I did some testing and it seemed to work well, but this block has so many nuances and we need to test it really well. We need to do good testing with pagination too, because if I remember correctly there are quirks about it. We also need to test existing blocks that remain unaffected.

ntsekouras · 2024-11-01T13:14:17Z

packages/block-library/src/query/edit/inspector-controls/sticky-control.js

@@ -8,6 +8,7 @@ const stickyOptions = [
 	{ label: __( 'Include' ), value: '' },
 	{ label: __( 'Exclude' ), value: 'exclude' },
 	{ label: __( 'Only' ), value: 'only' },
+	{ label: __( 'Ignore' ), value: 'ignore' },


Ignore label is not self explanatory in this context and is quite similar to the exclude, where it's ignore post stickiness.

Maybe a different control can be used with help texts? --cc @jameskoster

Perhaps 'Ignore stickiness' is okay for now?

Add Ignore option to sticky options for Query Loop block

7eaeb8c

coreyworrell requested a review from ajitbohra as a code owner October 17, 2024 18:48

coreyworrell mentioned this pull request Oct 17, 2024

Allow sticky posts to be ignored WordPress/wordpress-develop#7584

Open

carolinan added [Type] Enhancement A suggestion for improvement. [Block] Query Loop Affects the Query Loop Block Needs PHP backport Needs PHP backport to Core labels Oct 23, 2024

Add compat for query loop vars

03b5e04

coreyworrell requested a review from spacedmonkey as a code owner October 24, 2024 17:03

draganescu reviewed Oct 28, 2024

View reviewed changes

Remove whitespace at end of line

1ce1e42

Create backport-changelog file

60cb502

ntsekouras reviewed Nov 1, 2024

View reviewed changes

lib/compat/wordpress-6.7/blocks.php Outdated Show resolved Hide resolved

ntsekouras reviewed Nov 1, 2024

View reviewed changes

coreyworrell added 3 commits November 4, 2024 10:08

Merge branch 'WordPress:trunk' into patch-1

2d9c182

Add compat for 6.8

ccc2ca9

Remove patch from 6.7

a1a4394

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Ignore` option to sticky options for Query Loop block #66222

Add `Ignore` option to sticky options for Query Loop block #66222

coreyworrell commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024 •

edited

Loading

coreyworrell commented Oct 17, 2024

carolinan commented Oct 23, 2024

coreyworrell commented Oct 24, 2024

carolinan commented Oct 28, 2024

draganescu left a comment

draganescu Oct 28, 2024

coreyworrell Oct 29, 2024

draganescu Oct 28, 2024

coreyworrell Oct 29, 2024

draganescu Oct 28, 2024

carolinan Oct 28, 2024 •

edited

Loading

ntsekouras Nov 1, 2024

coreyworrell commented Oct 29, 2024 •

edited

Loading

ntsekouras commented Nov 1, 2024

ntsekouras Nov 1, 2024

jameskoster Nov 1, 2024

Add Ignore option to sticky options for Query Loop block #66222

Are you sure you want to change the base?

Add Ignore option to sticky options for Query Loop block #66222

Conversation

coreyworrell commented Oct 17, 2024 • edited Loading

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

github-actions bot commented Oct 17, 2024 • edited Loading

coreyworrell commented Oct 17, 2024

carolinan commented Oct 23, 2024

coreyworrell commented Oct 24, 2024

carolinan commented Oct 28, 2024

draganescu left a 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

carolinan Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coreyworrell commented Oct 29, 2024 • edited Loading

ntsekouras commented Nov 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `Ignore` option to sticky options for Query Loop block #66222

Add `Ignore` option to sticky options for Query Loop block #66222

coreyworrell commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024 •

edited

Loading

carolinan Oct 28, 2024 •

edited

Loading

coreyworrell commented Oct 29, 2024 •

edited

Loading