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

Timestamp:

06/03/2020 02:35:31 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Reformat the orderby section of WP_Term_Query::__construct() for better readability.

This makes it more consistent with the fields section.

See #49572.

File:

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

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

@@ -97 +97 @@
      *     @type int|array    $object_ids             Optional. Object ID, or array of object IDs. Results will be
      *                                                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', 'description', 'parent'),
-     *                                                'count' for term taxonomy count, '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`, or
-     *                                                'none' to omit the ORDER BY clause. Defaults to 'name'.
+     *     @type string       $orderby                Field(s) to order terms by. Accepts:
+     *                                                - term fields ('name', 'slug', 'term_group', 'term_id', 'id',
+     *                                                  'description', 'parent').
+     *                                                - 'count' for term taxonomy count.
+     *                                                - '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.
      *                                                Accepts 'ASC' (ascending) or 'DESC' (descending).
@@ -143 +147 @@
      *     @type int|array    $term_taxonomy_id       Optional. Term taxonomy ID, or array of term taxonomy IDs,
      *                                                to match when querying terms.
-     *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants (even
-     *                                                if $hide_empty is set to true). Default true.
+     *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants
+     *                                                (even if $hide_empty is set to true). Default true.
      *     @type string       $search                 Search criteria to match terms. Will be SQL-formatted with
      *                                                wildcards before and after. Default empty.
@@ -397 +401 @@
             $_orderby = 'term_id';
         }
+
         $orderby = $this->parse_orderby( $_orderby );