WordPress.org

Make WordPress Core

Ticket #42019: 42019.patch

File 42019.patch, 3.7 KB (added by birgire, 4 years ago)
  • src/wp-includes/category-template.php

    diff --git src/wp-includes/category-template.php src/wp-includes/category-template.php
    index c9bf0d2..202af1f 100644
    function wp_list_categories( $args = '' ) { 
    663663 * @since 2.3.0
    664664 * @since 4.8.0 Added the `show_count` argument.
    665665 *
    666  * @param array|string|null $args Optional. Override default arguments.
     666 * @param array|string|null $args {
     667 *     Optional. Array of arguments for generating a tag cloud. Default empty.
     668 *
     669 *     @type int          $smallest   Smallest font size used to display tags. Paired
     670 *                                    with the value of `$unit`, to determine CSS text
     671 *                                    size unit. Default 8 (pt).
     672 *     @type int          $largest    Largest font size used to display tags. Paired
     673 *                                    with the value of `$unit`, to determine CSS text
     674 *                                    size unit. Default 22 (pt).
     675 *     @type string       $unit       CSS text size unit to use with the `$smallest`
     676 *                                    and `$largest` values. Accepts any valid CSS text
     677 *                                    size unit. Default 'pt'.
     678 *     @type int          $number     The number of tags to return. Accepts any
     679 *                                    positive integer or zero to return all.
     680 *                                    Default 0.
     681 *     @type string       $format     Format to display the tag cloud in. Accepts 'flat'
     682 *                                    (tags separated with spaces), 'list' (tags displayed
     683 *                                    in an unordered list), or 'array' (returns an array).
     684 *                                    Default 'flat'.
     685 *     @type string       $separator  HTML or text to separate the tags. Default "\n" (newline).
     686 *     @type string       $orderby    Value to order tags by. Accepts 'name' or 'count'.
     687 *                                    Default 'name'. The {@see 'tag_cloud_sort'} filter
     688 *                                    can also affect how tags are sorted.
     689 *     @type string       $order      How to order the tags. Accepts 'ASC' (ascending),
     690 *                                    'DESC' (descending), or 'RAND' (random). Default 'ASC'.       
     691 *     @type array|string $exclude    Array or comma/space-separated string of term ids to exclude.
     692 *                                    If $include is non-empty, $exclude is ignored.
     693 *                                    Default empty array.
     694 *     @type array|string $include    Array or comma/space-separated string of term ids to include.
     695 *                                    Default empty array.       
     696 *     @type string       $link       Wheter to display term editing links or term permalinks.
     697 *                                    Accepts 'edit' and 'view'. Default 'view'.
     698 *     @type string|array $taxonomy   Taxonomy name, or array of taxonomies, to which results should
     699 *                                    be limited. Default 'post_tag'.
     700 *     @type string       $post_type  The post type. Used to highlight the proper post type
     701 *                                    menu on the linked page. Defaults to the first post_type associated
     702 *                                    with the taxonomy.
     703 *     @type bool         $echo       Whether or not to echo the return. Default true.
     704 *     @type bool|int     $show_count Whether to display the tag counts. Default 0. Accepts
     705 *                                    0, 1, or their bool equivalents.
     706 * }
    667707 * @return void|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
    668708 *                    Otherwise, this function outputs the tag cloud.
    669709 */