Changeset 50614 for trunk/src/wp-includes/class-wp-term-query.php

Timestamp:

03/29/2021 09:33:32 PM (4 years ago)

Author:

davidbaumwald

Message:

Docs: Fix indentation for wp_term_query->construct method parameters.

The fields and orderby properties in WP_Term_Query are arrays and each accepts a variety of keys. To properly indent each key in the docblock, a * should be used, not -.

Props whyisjake, audrasjb, SergeyBiryukov.
Fixes #52839.

File:

• trunk/src/wp-includes/class-wp-term-query.php (modified) (2 diffs)

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

@@ -98 +98 @@
      *                                                limited to terms associated with these objects.
      *     @type string       $orderby                Field(s) to order terms by. Accepts:
-     *                                                - term fields ('name', 'slug', 'term_group', 'term_id', 'id',
+     *                                                * term fields ('name', 'slug', 'term_group', 'term_id', 'id',
      *                                                  'description', 'parent', 'term_order'). Unless `$object_ids`
      *                                                  is not empty, 'term_order' is treated the same as 'term_id'.
-     *                                                - 'count' to use the number of objects associated with the term.
-     *                                                - 'include' to match the 'order' of the $include param.
-     *                                                - 'slug__in' to match the 'order' of the $slug param.
-     *                                                - 'meta_value', 'meta_value_num'.
-     *                                                - the value of `$meta_key`.
-     *                                                - the array keys of `$meta_query`.
-     *                                                - 'none' to omit the ORDER BY clause.
+     *                                                * 'count' to use the number of objects associated with the term.
+     *                                                * 'include' to match the 'order' of the $include param.
+     *                                                * 'slug__in' to match the 'order' of the $slug param.
+     *                                                * 'meta_value', 'meta_value_num'.
+     *                                                  the value of `$meta_key`.
+     *                                                  the array keys of `$meta_query`.
+     *                                                * 'none' to omit the ORDER BY clause.
      *                                                Defaults to 'name'.
      *     @type string       $order                  Whether to order terms in ascending or descending order.
@@ -128 +128 @@
      *     @type int          $offset                 The number by which to offset the terms query. Default empty.
      *     @type string       $fields                 Term fields to query for. Accepts:
-     *                                                - 'all' Returns an array of complete term objects (`WP_Term[]`).
-     *                                                - 'all_with_object_id' Returns an array of term objects
+     *                                                * 'all' Returns an array of complete term objects (`WP_Term[]`).
+     *                                                * 'all_with_object_id' Returns an array of term objects
      *                                                  with the 'object_id' param (`WP_Term[]`). Works only
      *                                                  when the `$object_ids` parameter is populated.
-     *                                                - 'ids' Returns an array of term IDs (`int[]`).
-     *                                                - 'tt_ids' Returns an array of term taxonomy IDs (`int[]`).
-     *                                                - 'names' Returns an array of term names (`string[]`).
-     *                                                - 'slugs' Returns an array of term slugs (`string[]`).
-     *                                                - 'count' Returns the number of matching terms (`int`).
-     *                                                - 'id=>parent' Returns an associative array of parent term IDs,
+     *                                                * 'ids' Returns an array of term IDs (`int[]`).
+     *                                                * 'tt_ids' Returns an array of term taxonomy IDs (`int[]`).
+     *                                                * 'names' Returns an array of term names (`string[]`).
+     *                                                * 'slugs' Returns an array of term slugs (`string[]`).
+     *                                                * 'count' Returns the number of matching terms (`int`).
+     *                                                * 'id=>parent' Returns an associative array of parent term IDs,
      *                                                   keyed by term ID (`int[]`).
-     *                                                - 'id=>name' Returns an associative array of term names,
+     *                                                * 'id=>name' Returns an associative array of term names,
      *                                                   keyed by term ID (`string[]`).
-     *                                                - 'id=>slug' Returns an associative array of term slugs,
+     *                                                * 'id=>slug' Returns an associative array of term slugs,
      *                                                   keyed by term ID (`string[]`).
      *                                                Default 'all'.