[wp-trac] [WordPress Trac] #36693: Documentation: Missing argument (style) in the wp_list_categories() function's docblock
WordPress Trac
noreply at wordpress.org
Wed Apr 27 20:57:59 UTC 2016
#36693: Documentation: Missing argument (style) in the wp_list_categories()
function's docblock
-------------------------+-----------------------------
Reporter: birgire | Owner:
Type: enhancement | Status: new
Priority: normal | Milestone: Awaiting Review
Component: Taxonomy | Version: trunk
Severity: normal | Keywords:
Focuses: docs |
-------------------------+-----------------------------
The {{{'style'}}} input argument is missing in the
{{{wp_list_categories()}}} function's DocBlock.
I also ordered the DocBlock's arguments alphabetically, because that's
easier to read and the default array is also ordered that way.
== To consider: ==
The {{{'class'}}} and {{{'pad_counts'}}} arguments are also explicitly
checked for in {{{wp_list_categories()}}} but they aren't part of the
function's docblock:
{{{
if ( ! isset( $r['class'] ) )
$r['class'] = ( 'category' == $r['taxonomy'] ) ? 'categories' :
$r['taxonomy'];
}}}
and
{{{
if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical']
)
$r['pad_counts'] = true;
}}}
I also wonder if we should document the {{{'include'}}} argument or add a
reference to the {{{get_the_categories()}}} function or the
{{{get_terms()}}} function for other supported input arguments.
But I'm not sure how that would fit the documentation rules.
The old Codex page on WayBack Machine:
https://web.archive.org/web/20150420185400/https://codex.wordpress.org/Function_Reference/wp_list_categories
did mention the {{{'style'}}} and {{{'pad_counts'}}} input parameters (and
also {{{'walker'}}}).
--
Ticket URL: <https://core.trac.wordpress.org/ticket/36693>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list