<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[37571] trunk/src/wp-includes/category-template.php: Docs: Reorder argument descriptions in the DocBlock for `wp_list_categories()` to match the default arguments list and improve reading at a glance.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/37571">37571</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37571","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-25 19:39:32 +0000 (Wed, 25 May 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Reorder argument descriptions in the DocBlock for `wp_list_categories()` to match the default arguments list and improve reading at a glance.
Props birgire for the initial patch.
Fixes <a href="https://core.trac.wordpress.org/ticket/36693">#36693</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescategorytemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/category-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php 2016-05-25 19:35:07 UTC (rev 37570)
+++ trunk/src/wp-includes/category-template.php 2016-05-25 19:39:32 UTC (rev 37571)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -500,44 +500,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of optional arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $show_option_all Text to display for showing all categories. Default empty string.
- * @type string $show_option_none Text to display for the 'no categories' option.
- * Default 'No categories'.
- * @type string $orderby The column to use for ordering categories. Default 'ID'.
- * @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
- * Default 'ASC'.
- * @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
- * @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
- * Default 1.
- * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
- * Default 1.
- * @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
- * under [cat name]'.
- * @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link().
- * Default empty string (default feed).
- * @type string $feed_image URL of an image to use for the feed link. Default empty string.
</del><span class="cx" style="display: block; padding: 0 10px"> * @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int|array $current_category ID of category, or array of IDs of categories, that should get the
+ * 'current-cat' class. Default 0.
+ * @type int $depth Category depth. Used for tab indentation. Default 0.
+ * @type bool|int $echo True to echo markup, false to return it. Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
</span><span class="cx" style="display: block; padding: 0 10px"> * If `$hierarchical` is true, descendants of `$exclude` terms will also
</span><span class="cx" style="display: block; padding: 0 10px"> * be excluded; see `$exclude_tree`. See get_terms().
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty string.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
</span><span class="cx" style="display: block; padding: 0 10px"> * with their descendants. See get_terms(). Default empty string.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool|int $echo True to echo markup, false to return it. Default 1.
- * @type int|array $current_category ID of category, or array of IDs of categories, that should get the
- * 'current-cat' class. Default 0.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
+ * under [cat name]'.
+ * @type string $feed_image URL of an image to use for the feed link. Default empty string.
+ * @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link().
+ * Default empty string (default feed).
+ * @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
+ * Default 1.
+ * @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in
+ * the list. Default false (title will always be shown).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $hierarchical Whether to include terms that have non-empty descendants.
</span><span class="cx" style="display: block; padding: 0 10px"> * See get_terms(). Default true.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $title_li Text to use for the list title `<li>` element. Pass an empty string
- * to disable. Default 'Categories'.
- * @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in
- * the list. Default false (title will always be shown).
- * @type int $depth Category depth. Used for tab indentation. Default 0.
- * @type string $taxonomy Taxonomy name. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
+ * Default 'ASC'.
+ * @type string $orderby The column to use for ordering categories. Default 'ID'.
+ * @type string $separator Separator between links. Default '<br />'.
+ * @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
+ * @type string $show_option_all Text to display for showing all categories. Default empty string.
+ * @type string $show_option_none Text to display for the 'no categories' option.
+ * Default 'No categories'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $style The style used to display the categories list. If 'list', categories
</span><span class="cx" style="display: block; padding: 0 10px"> * will be output as an unordered list. If left empty or another value,
</span><span class="cx" style="display: block; padding: 0 10px"> * categories will be output separated by `<br>` tags. Default 'list'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $separator Separator between links. Default '<br />'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $taxonomy Taxonomy name. Default 'category'.
+ * @type string $title_li Text to use for the list title `<li>` element. Pass an empty string
+ * to disable. Default 'Categories'.
+ * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
+ * Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false|string HTML content only if 'echo' argument is 0.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>