Improved sticky post query

[spacedmonkey]

Currently with the WP_Query class calls a get_posts to get a array of posts to include on the home / blog page. However this get_posts will not obey parameters passed to the main WP_Query class.

[rehanali]

Added patch

[peterwilsoncc]

36907.patch​ looks good to me.

Not to self so I don't look it up again, get_posts() has no_found_rows set already so it's not needed here.

Trac ticket: https://core.trac.wordpress.org/ticket/36907

[peterwilsoncc]

The pull request looks good for commit, marking as such.

[spacedmonkey]

In 52982:

Query: Improved sticky post query

Ensure that the parameters update_post_meta_cache, update_post_term_cache, cache_results, suppress_filters and
lazy_load_term_meta that are passed to WP_Query, are also passed down to the secondary query used to get sticky
posts.

Props Spacedmonkey, peterwilsoncc, rehanali, uday17035.
Fixes #36907.

Merged.

[SergeyBiryukov]

It's not quite clear why [52982] removed the 'nopaging' => true argument from the get_posts() call in question, as neither the ticket nor the commit message mention the removal.

With that change, only 5 sticky posts are displayed now. This is a backward compatibility break, see #55444.

36907.diff​ restores 'nopaging' => true and reorder the parameters for consistency with similar calls elsewhere.

[SergeyBiryukov]

In 52985:

Tests: Use a more descriptive name for the sticky posts test that verifies the parameters from the main query.

Reorder the parameters of the get_posts() call for consistency with similar calls elsewhere.

Follow-up to [52982].

See #36907.

[SergeyBiryukov]

36907.2.diff​ is a refresh after [52985].

This could also use a unit test.

[SergeyBiryukov]

#55444 was marked as a duplicate.

[spacedmonkey]

Good catch @SergeyBiryukov . No paging / posts per page was removed at the last minute. It should not have been. I have created a follow on PR at ​#2454. Can you take a look?

Trac ticket: https://core.trac.wordpress.org/ticket/36907

Trac ticket: https://core.trac.wordpress.org/ticket/36907

LGTM.

Are you able to put the following test in to Tests_Query_Stickies be sure it's not broken next time?

{{{php
/

• Ensure all sticky posts are included, no matter how many. *
• @ticket 36907 */

public function test_query_should_return_all_stickies() {

$old_option = get_option( 'sticky_posts' );
foreach ( self::$posts as $post_id ) {

stick_post( $post_id );

}

$q = new WP_Query( array( 'post_type' => 'post' ) );
22 sticky posts, 1 hello world.
$this->assertCount( 23, $q->posts );

update_option( 'sticky_posts', $old_option );

}
}}}

I am not sure if the options table is included in the test suite's DB transaction. If it is then the last line can be dropped as the table should bre reset as part of tear down.

[peterwilsoncc]

Removing commit keyword while the follow up commit is finalised.

@peterwilsoncc Added a unit test.

[spacedmonkey]

In 52990:

Query: Ensure that sticky post query returns all sticky posts.

Ensure that the posts_per_page parameter submit to sticky post query matches the number of sticky posts requested.

Follow-up to [52982]

Props Spacedmonkey, peterwilsoncc.
See #36907.

[peterwilsoncc]

Just tidying up keywords to keep reports clean.

@spacedmonkey I presume you're keeping this open to monitor, are you able to close once you're happy.