WordPress.org

Make WordPress Core

Changeset 36135


Ignore:
Timestamp:
12/31/2015 11:29:19 AM (5 years ago)
Author:
swissspidy
Message:

Docs: Improve readability of the default arguments of wp_list_categories().

Adds missing documentation for the separator argument introduced in [35140].

Props birgire for initial patch.
Fixes #34751.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/category-template.php

    r36013 r36135  
    521521 *     @type int          $depth                 Category depth. Used for tab indentation. Default 0.
    522522 *     @type string       $taxonomy              Taxonomy name. Default 'category'.
     523 *     @type string       $separator             Separator between links. Default '<br />'.
    523524 * }
    524525 * @return false|string HTML content only if 'echo' argument is 0.
     
    526527function wp_list_categories( $args = '' ) {
    527528    $defaults = array(
    528         'show_option_all' => '', 'show_option_none' => __('No categories'),
    529         'orderby' => 'name', 'order' => 'ASC',
    530         'style' => 'list',
    531         'show_count' => 0, 'hide_empty' => 1,
    532         'use_desc_for_title' => 1, 'child_of' => 0,
    533         'feed' => '', 'feed_type' => '',
    534         'feed_image' => '', 'exclude' => '',
    535         'exclude_tree' => '', 'current_category' => 0,
    536         'hierarchical' => true, 'title_li' => __( 'Categories' ),
     529        'child_of'            => 0,
     530        'current_category'    => 0,
     531        'depth'               => 0,
     532        'echo'                => 1,
     533        'exclude'             => '',
     534        'exclude_tree'        => '',
     535        'feed'                => '',
     536        'feed_image'          => '',
     537        'feed_type'           => '',
     538        'hide_empty'          => 1,
    537539        'hide_title_if_empty' => false,
    538         'echo' => 1, 'depth' => 0,
    539         'separator' => '<br />',
    540         'taxonomy' => 'category'
     540        'hierarchical'        => true,
     541        'order'               => 'ASC',
     542        'orderby'             => 'name',
     543        'separator'           => '<br />',
     544        'show_count'          => 0,
     545        'show_option_all'     => '',
     546        'show_option_none'    => __( 'No categories' ),
     547        'style'               => 'list',
     548        'taxonomy'            => 'category',
     549        'title_li'            => __( 'Categories' ),
     550        'use_desc_for_title'  => 1,
    541551    );
    542552
Note: See TracChangeset for help on using the changeset viewer.