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

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.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (3 diffs)

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,
+            );
         }