Changeset 62041

Timestamp:

03/17/2026 09:08:46 PM (2 months ago)

Author:

westonruter

Message:

Docs: Indicate that get_posts() can take a query string in addition to an array of query vars.

A string is supported by virtue of wp_parse_args() being used on the supplied arguments. While a string is not currently passed to get_posts() in core, a significant number of plugins are doing so. So in addition to documenting actual ecosystem usage, this also adds a test to ensure that supplying a query string continues to be supported in the future.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11179

Follow-up to r11528.

Props rodrigosprimo, westonruter, shailu25, mukesh27.
See #64224, #10047.
Fixes #64813.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (1 diff)
• tests/phpunit/tests/post/getPosts.php (modified) (1 diff)

trunk/src/wp-includes/post.php

@@ -2600 +2600 @@
  * @see WP_Query::parse_query()
  *
- * @param array $args {
- *     Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments.
+ * @param array|string $args {
+ *     Optional. Array or query string of arguments to retrieve posts.
+ *     See WP_Query::parse_query() for all available arguments.
  *
  *     @type int        $numberposts      Total number of posts to retrieve. Is an alias of `$posts_per_page`

trunk/tests/phpunit/tests/post/getPosts.php

@@ -164 +164 @@
         $this->assertSame( array( $p3 ), $found );
     }
+
+    /**
+     * Verifies that get_posts() accepts a query string for the `$args` parameter.
+     *
+     * @ticket 64813
+     */
+    public function test_should_accept_query_string_args(): void {
+        self::factory()->post->create();
+        $second_post_id = self::factory()->post->create();
+        $found_post_ids = get_posts( 'numberposts=1&fields=ids' );
+
+        $this->assertSame( array( $second_post_id ), $found_post_ids );
+    }
 }