REST API: Change posts endpoint to ignore_sticky=true by default

This restores the 6.7 and below behavior for the posts endpoint which did not include sticky posts by default.

Follow-up to [59801].

Reviewed by desrosj.
Merges [60197] to the 6.8 branch.

Props nikunj8866, SirLouen, ankitmaru, wildworks, karthikeya01, Mamaduka, spacedmonkey, jorbin.
Fixes #63307. See #35907.


git-svn-id: https://develop.svn.wordpress.org/branches/6.8@60200 602fd350-edb4-49c9-b593-d223f7449a82

Author: aaronjorbin

src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -3075,7 +3075,7 @@ public function get_collection_params() {
 			$query_params['ignore_sticky'] = array(
 				'description' => __( 'Whether to ignore sticky posts or not.' ),
 				'type'        => 'boolean',
-				'default'     => false,
+				'default'     => true,
 			);
 		}
 

tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -661,27 +661,32 @@ public function test_get_items_search_query() {
 		$this->assertSame( 'Search Result', $data[0]['title']['rendered'] );
 	}
 
+	/**
+	 * @ticket 63307
+	 */
 	public function test_get_items_slug_query() {
-		self::factory()->post->create(
+		$id1 = self::factory()->post->create(
 			array(
 				'post_title'  => 'Apple',
 				'post_status' => 'publish',
 			)
 		);
-		self::factory()->post->create(
+		$id2 = self::factory()->post->create(
 			array(
 				'post_title'  => 'Banana',
 				'post_status' => 'publish',
 			)
 		);
 
+		update_option( 'sticky_posts', array( $id2 ) );
+
 		$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
 		$request->set_param( 'slug', 'apple' );
 		$response = rest_get_server()->dispatch( $request );
 		$this->assertSame( 200, $response->get_status() );
 		$data = $response->get_data();
 		$this->assertCount( 1, $data );
-		$this->assertSame( 'Apple', $data[0]['title']['rendered'] );
+		$this->assertSame( 'Apple', $data[0]['title']['rendered'], 'Return the post with the given slug' );
 	}
 
 	public function test_get_items_multiple_slugs_array_query() {
@@ -5970,13 +5975,14 @@ public function test_get_posts_with_pagination() {
 	}
 
 	/**
-	 * Test the REST API support for `ignore_sticky_posts`.
+	 * Test the REST API doesn't prioritize sticky posts by default.
 	 *
 	 * @ticket 35907
+	 * @ticket 63307
 	 *
 	 * @covers WP_REST_Posts_Controller::get_items
 	 */
-	public function test_get_posts_ignore_sticky_default_prepends_sticky_posts() {
+	public function test_get_posts_ignore_sticky_by_default() {
 		$id1 = self::$post_id;
 		// Create more recent post to avoid automatically placing other at the top.
 		$id2 = self::factory()->post->create( array( 'post_status' => 'publish' ) );
@@ -5986,40 +5992,54 @@ public function test_get_posts_ignore_sticky_default_prepends_sticky_posts() {
 		$request  = new WP_REST_Request( 'GET', '/wp/v2/posts' );
 		$response = rest_get_server()->dispatch( $request );
 		$data     = $response->get_data();
+		$rest_ids = wp_list_pluck( $data, 'id' );
 
-		$this->assertSame( $data[0]['id'], $id1, 'Response has sticky post at the top.' );
-		$this->assertSame( $data[1]['id'], $id2, 'It is followed by most recent post.' );
+		$this->assertSame( $data[0]['id'], $id2, 'Response has no sticky post at the top.' );
+
+		$posts_query = new WP_Query( array( 'ignore_sticky_posts' => true ) );
+		$post_ids    = wp_list_pluck( $posts_query->get_posts(), 'ID' );
+		$this->assertSame( $rest_ids, $post_ids, 'Response is same as WP_Query with ignore_sticky_posts=true.' );
 	}
 
 	/**
 	 * Test the REST API support for `ignore_sticky_posts`.
 	 *
 	 * @ticket 35907
+	 * @ticket 63307
 	 *
 	 * @covers WP_REST_Posts_Controller::get_items
 	 */
-	public function test_get_posts_ignore_sticky_ignores_post_stickiness() {
+	public function test_get_posts_ignore_sticky_false_prepends_sticky_posts() {
 		$id1 = self::$post_id;
+		// Create more recent post to avoid automatically placing other at the top.
 		$id2 = self::factory()->post->create( array( 'post_status' => 'publish' ) );
 
 		update_option( 'sticky_posts', array( $id1 ) );
 
 		$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
-		$request->set_param( 'ignore_sticky', true );
+		$request->set_param( 'ignore_sticky', false );
 		$response = rest_get_server()->dispatch( $request );
 		$data     = $response->get_data();
+		$rest_ids = wp_list_pluck( $data, 'id' );
 
-		$this->assertSame( $data[0]['id'], $id2, 'Response has no sticky post at the top.' );
+		$this->assertSame( $data[0]['id'], $id1, 'Response has sticky post at the top.' );
+		$this->assertSame( $data[1]['id'], $id2, 'It is followed by most recent post.' );
+
+		$posts_query = new WP_Query();
+		$post_ids    = wp_list_pluck( $posts_query->get_posts(), 'ID' );
+		$this->assertSame( $rest_ids, $post_ids, 'Response is same as WP_Query with ignore_sticky_posts=false.' );
 	}
 
 	/**
 	 * Test the REST API support for `ignore_sticky_posts`.
 	 *
 	 * @ticket 35907
+	 * @ticket 63307
 	 *
 	 * @covers WP_REST_Posts_Controller::get_items
 	 */
 	public function test_get_posts_ignore_sticky_honors_include() {
+
 		$id1 = self::$post_id;
 		$id2 = self::factory()->post->create( array( 'post_status' => 'publish' ) );
 
@@ -6029,9 +6049,19 @@ public function test_get_posts_ignore_sticky_honors_include() {
 		$request->set_param( 'include', array( $id2 ) );
 		$response = rest_get_server()->dispatch( $request );
 		$data     = $response->get_data();
+		$rest_ids = wp_list_pluck( $data, 'id' );
 
 		$this->assertCount( 1, $data, 'Only one post is expected to be returned.' );
 		$this->assertSame( $data[0]['id'], $id2, 'Returns the included post.' );
+
+		$posts_query = new WP_Query(
+			array(
+				'post__in'            => array( $id2 ),
+				'ignore_sticky_posts' => true,
+			)
+		);
+		$post_ids    = wp_list_pluck( $posts_query->get_posts(), 'ID' );
+		$this->assertSame( $rest_ids, $post_ids, 'Response is same as WP_Query with ignore_sticky_posts=truehas no sticky post at the top.' );
 	}
 
 	/**

tests/qunit/fixtures/wp-api-generated.js

@@ -633,7 +633,7 @@ mockedApiResponse.Schema = {
                         "ignore_sticky": {
                             "description": "Whether to ignore sticky posts or not.",
                             "type": "boolean",
-                            "default": false,
+                            "default": true,
                             "required": false
                         },
                         "format": {