From d6c7a479f453a600ca2cd000f2668fd0927b0f7a Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 22 Jul 2020 11:34:32 +0000 Subject: [PATCH] Docs: Correct type and improve description for the `$fields` parameter of `WP_Query::parse_query()`. Props ocean90, palmiak, johannadevos, noisysocks. Fixes #44305. git-svn-id: https://develop.svn.wordpress.org/trunk@48563 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-query.php | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/class-wp-query.php b/src/wp-includes/class-wp-query.php index d339285506..7054cd0350 100644 --- a/src/wp-includes/class-wp-query.php +++ b/src/wp-includes/class-wp-query.php @@ -649,9 +649,12 @@ class WP_Query { * See WP_Date_Query::__construct(). * @type int $day Day of the month. Default empty. Accepts numbers 1-31. * @type bool $exact Whether to search by exact keyword. Default false. - * @type string|array $fields Which fields to return. Single field or all fields (string), - * or array of fields. 'id=>parent' uses 'id' and 'post_parent'. - * Default all fields. Accepts 'ids', 'id=>parent'. + * @type string $fields Post fields to query for. Accepts: + * - '' Returns an array of complete post objects (`WP_Post[]`). + * - 'ids' Returns an array of post IDs (`int[]`). + * - 'id=>parent' Returns an associative array of parent post IDs, + * keyed by post ID (`int[]`). + * Default ''. * @type int $hour Hour of the day. Default empty. Accepts numbers 0-23. * @type int|bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false * excludes stickies from 'post__in'. Accepts 1|true, 0|false.