WordPress.org

Make WordPress Core

Ticket #42650: 42650.patch

File 42650.patch, 4.0 KB (added by milana_cap, 3 years ago)
  • src/wp-includes/category-template.php

     
    668668 * @since 2.3.0
    669669 * @since 4.8.0 Added the `show_count` argument.
    670670 *
    671  * @param array|string|null $args Optional. Override default arguments.
     671 * @param array|string|null $args {
     672 *     Optional. Override default arguments.
     673 *
     674 *     @type int            $smallest    Smallest font size used to display tags. Paired
     675 *                                       with the value of `$unit`, to determine CSS text
     676 *                                       size unit. Default 8 (pt).
     677 *     @type int            $largest     Largest font size used to display tags. Paired
     678 *                                       with the value of `$unit`, to determine CSS text
     679 *                                       size unit. Default 22 (pt).
     680 *     @type string         $unit        CSS text size unit to use with the `$smallest`
     681 *                                       and `$largest` values. Accepts any valid CSS text
     682 *                                       size unit. Default 'pt'.
     683 *     @type int            $number      The number of tags to return. Accepts any
     684 *                                       positive integer or zero to return all.
     685 *                                       Default 0.
     686 *     @type string         $format      Format to display the tag cloud in. Accepts 'flat'
     687 *                                       (tags separated with spaces), 'list' (tags displayed
     688 *                                       in an unordered list), or 'array' (returns an array).
     689 *                                       Default 'flat'.
     690 *     @type string         $separator   HTML or text to separate the tags. Default "\n" (newline).
     691 *     @type string         $orderby     Value to order tags by. Accepts 'name' or 'count'.
     692 *                                       Default 'name'. The {@see 'tag_cloud_sort'} filter
     693 *                                       can also affect how tags are sorted.
     694 *     @type string         $order       How to order the tags. Accepts 'ASC' (ascending),
     695 *                                       'DESC' (descending), or 'RAND' (random). Default 'ASC'.
     696 *     @type string         $exclude     Comma separated list of tags (term_id) to exclude.
     697 *                                       For example, exclude=5,27 means tags that have the term_id 5 or 27
     698 *                                       will NOT be displayed. Default: null.
     699 *     @type string         $include     Comma separated list of tags (term_id) to include.
     700 *                                       For example, include=5,27 means tags that have the term_id 5 or 27
     701 *                                       will NOT be displayed. Default: null.
     702 *     @type string         $link        Set link to allow edit of a particular tag. Accepts 'view' and 'edit'.
     703 *                                       Default: view.
     704 *     @type string|array   $taxonomy    Taxonomy or array of taxonomies to use in generating the cloud.
     705 *                                       Accepts any registered taxonomy or array of taxonomies (as of Version 3.1).
     706 *                                       Default: post_tag.
     707 *     @type string         $post_type   Post type passed to edit.php for the popular tags edit links.
     708 *                                       Used only when $link is set to 'edit'.
     709 *     @type boolean        $echo        Display the result or return it in a variable.
     710 *                                       Default: true.
     711 *     @type bool|int       $show_count  Whether to display the tag counts. Default 0. Accepts
     712 *                                       0, 1, or their bool equivalents.
     713 * }
    672714 * @return void|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
    673715 *                    Otherwise, this function outputs the tag cloud.
    674716 */