Changeset 48563

Timestamp:

07/22/2020 11:34:32 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct type and improve description for the $fields parameter of WP_Query::parse_query().

Props ocean90, palmiak, johannadevos, noisysocks.
Fixes #44305.

File:

• trunk/src/wp-includes/class-wp-query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-query.php

@@ -650 +650 @@
      *     @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