Changeset 59801

Timestamp:

02/10/2025 10:21:51 PM (3 months ago)

Author:

peterwilsoncc

Message:

REST API: Add support for the ignore_sticky_posts argument.

Introduce ignore_sticky as a boolean argument for the posts endpoint for requests without the sticky posts being stuck. The new argument defaults to false with the value of the argument passed to WP_Query's ignore_sticky_posts parameter.

Props audrasjb, danielbachhuber, joemcgill, johnbillion, jorbin, mamaduka, rmccue.
Fixes #35907.

Location:

trunk

Files:

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

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

@@ -248 +248 @@
             'exclude'        => 'post__not_in',
             'include'        => 'post__in',
+            'ignore_sticky'  => 'ignore_sticky_posts',
             'menu_order'     => 'menu_order',
             'offset'         => 'offset',
@@ -336 +337 @@
                 $args['post__not_in'] = array_merge( $args['post__not_in'], $sticky_posts );
             }
+        }
+
+        /*
+         * Honor the original REST API `post__in` behavior. Don't prepend sticky posts
+         * when `post__in` has been specified.
+         */
+        if ( ! empty( $args['post__in'] ) ) {
+            unset( $args['ignore_sticky_posts'] );
         }
 
@@ -3046 +3055 @@
                 'type'        => 'boolean',
             );
+
+            $query_params['ignore_sticky'] = array(
+                'description' => __( 'Whether to ignore sticky posts or not.' ),
+                'type'        => 'boolean',
+                'default'     => false,
+            );
         }
 

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

@@ -198 +198 @@
                 'exclude',
                 'format',
+                'ignore_sticky',
                 'include',
                 'modified_after',
@@ -5717 +5718 @@
 
     /**
+     * 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_default_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' );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        $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.' );
+    }
+
+    /**
+     * 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_ignores_post_stickiness() {
+        $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( '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();
+
+        $this->assertCount( 1, $data, 'Only one post is expected to be returned.' );
+        $this->assertSame( $data[0]['id'], $id2, 'Returns the included post.' );
+    }
+
+    /**
      * Internal function used to disable an insert query which
      * will trigger a wpdb error for testing purposes.

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

@@ -626 +626 @@
                             "description": "Limit result set to items that are sticky.",
                             "type": "boolean",
+                            "required": false
+                        },
+                        "ignore_sticky": {
+                            "description": "Whether to ignore sticky posts or not.",
+                            "type": "boolean",
+                            "default": false,
                             "required": false
                         },