WordPress.org

Make WordPress Core

Changeset 47897


Ignore:
Timestamp:
06/03/2020 02:35:31 PM (18 months 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-term-query.php

    r47808 r47897  
    9797     *     @type int|array    $object_ids             Optional. Object ID, or array of object IDs. Results will be
    9898     *                                                limited to terms associated with these objects.
    99      *     @type string       $orderby                Field(s) to order terms by. Accepts term fields ('name',
    100      *                                                'slug', 'term_group', 'term_id', 'id', 'description', 'parent'),
    101      *                                                'count' for term taxonomy count, 'include' to match the
    102      *                                                'order' of the $include param, 'slug__in' to match the
    103      *                                                'order' of the $slug param, 'meta_value', 'meta_value_num',
    104      *                                                the value of `$meta_key`, the array keys of `$meta_query`, or
    105      *                                                'none' to omit the ORDER BY clause. Defaults to 'name'.
     99     *     @type string       $orderby                Field(s) to order terms by. Accepts:
     100     *                                                - term fields ('name', 'slug', 'term_group', 'term_id', 'id',
     101     *                                                  'description', 'parent').
     102     *                                                - 'count' for term taxonomy count.
     103     *                                                - 'include' to match the 'order' of the $include param.
     104     *                                                - 'slug__in' to match the 'order' of the $slug param.
     105     *                                                - 'meta_value', 'meta_value_num'.
     106     *                                                - the value of `$meta_key`.
     107     *                                                - the array keys of `$meta_query`.
     108     *                                                - 'none' to omit the ORDER BY clause.
     109     *                                                Defaults to 'name'.
    106110     *     @type string       $order                  Whether to order terms in ascending or descending order.
    107111     *                                                Accepts 'ASC' (ascending) or 'DESC' (descending).
     
    143147     *     @type int|array    $term_taxonomy_id       Optional. Term taxonomy ID, or array of term taxonomy IDs,
    144148     *                                                to match when querying terms.
    145      *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants (even
    146      *                                                if $hide_empty is set to true). Default true.
     149     *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants
     150     *                                                (even if $hide_empty is set to true). Default true.
    147151     *     @type string       $search                 Search criteria to match terms. Will be SQL-formatted with
    148152     *                                                wildcards before and after. Default empty.
     
    397401            $_orderby = 'term_id';
    398402        }
     403
    399404        $orderby = $this->parse_orderby( $_orderby );
    400405
Note: See TracChangeset for help on using the changeset viewer.