Changeset 60200

Timestamp:

04/28/2025 04:47:40 PM (7 weeks ago)

Author:

jorbin

Message:

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.

Location:

branches/6.8

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (8 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

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

@@ -3076 +3076 @@
                 'description' => __( 'Whether to ignore sticky posts or not.' ),
                 'type'        => 'boolean',
-                'default'     => false,
+                'default'     => true,
             );
         }

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

@@ -662 +662 @@
     }
 
+    /**
+     * @ticket 63307
+     */
     public function test_get_items_slug_query() {
-        self::factory()->post->create(
+        $id1 = self::factory()->post->create(
             array(
                 'post_title'  => 'Apple',
@@ -669 +672 @@
             )
         );
-        self::factory()->post->create(
+        $id2 = self::factory()->post->create(
             array(
                 'post_title'  => 'Banana',
@@ -675 +678 @@
             )
         );
+
+        update_option( 'sticky_posts', array( $id2 ) );
 
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
@@ -682 +687 @@
         $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' );
     }
 
@@ -5971 +5976 @@
 
     /**
+     * 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_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' ) );
+
+        update_option( 'sticky_posts', array( $id1 ) );
+
+        $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'], $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_default_prepends_sticky_posts() {
+    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.
@@ -5984 +6017 @@
         update_option( 'sticky_posts', array( $id1 ) );
 
-        $request  = new WP_REST_Request( 'GET', '/wp/v2/posts' );
-        $response = rest_get_server()->dispatch( $request );
-        $data     = $response->get_data();
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $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'], $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.' );
     }
 
@@ -5996 +6035 @@
      *
      * @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_honors_include() {
+
         $id1 = self::$post_id;
         $id2 = self::factory()->post->create( array( 'post_status' => 'publish' ) );
@@ -6006 +6047 @@
 
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
-        $request->set_param( 'ignore_sticky', true );
-        $response = rest_get_server()->dispatch( $request );
-        $data     = $response->get_data();
-
-        $this->assertSame( $data[0]['id'], $id2, 'Response has no sticky post at the top.' );
-    }
-
-    /**
-     * Test the REST API support for `ignore_sticky_posts`.
-     *
-     * @ticket 35907
-     *
-     * @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' ) );
-
-        update_option( 'sticky_posts', array( $id1 ) );
-
-        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
         $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.' );
     }
 

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

@@ -634 +634 @@
                             "description": "Whether to ignore sticky posts or not.",
                             "type": "boolean",
-                            "default": false,
+                            "default": true,
                             "required": false
                         },