<!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>[25641] trunk/src/wp-includes/category-template.php: Inline documentation improvements for `Walker_Category` and `Walker_CategoryDropdown`.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25641">25641</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-09-28 18:01:26 +0000 (Sat, 28 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation improvements for `Walker_Category` and `Walker_CategoryDropdown`.
Also covers previously undocumented parameters.
See <a href="http://core.trac.wordpress.org/ticket/23406">#23406</a>, <a href="http://core.trac.wordpress.org/ticket/19249">#19249</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>Modified: trunk/src/wp-includes/category-template.php (25640 => 25641)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/category-template.php 2013-09-28 08:24:28 UTC (rev 25640)
+++ trunk/src/wp-includes/category-template.php 2013-09-28 18:01:26 UTC (rev 25641)
</span><span class="lines">@@ -763,6 +763,8 @@
</span><span class="cx"> */
</span><span class="cx"> class Walker_Category extends Walker {
</span><span class="cx"> /**
</span><ins>+ * What the class handles.
+ *
</ins><span class="cx"> * @see Walker::$tree_type
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> * @var string
</span><span class="lines">@@ -770,6 +772,8 @@
</span><span class="cx"> var $tree_type = 'category';
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Database fields to use.
+ *
</ins><span class="cx"> * @see Walker::$db_fields
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> * @todo Decouple this
</span><span class="lines">@@ -778,12 +782,16 @@
</span><span class="cx"> var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Starts the list before the elements are added.
+ *
</ins><span class="cx"> * @see Walker::start_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param int $depth Depth of category. Used for tab indentation.
- * @param array $args Will only append content if style argument value is 'list'.
</del><ins>+ * @param int $depth Depth of category. Used for tab indentation.
+ * @param array $args An array of arguments. Will only append content if style argument value is 'list'.
+ * @see wp_list_categories()
</ins><span class="cx"> */
</span><span class="cx"> function start_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> if ( 'list' != $args['style'] )
</span><span class="lines">@@ -794,12 +802,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Ends the list of after the elements are added.
+ *
</ins><span class="cx"> * @see Walker::end_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param int $depth Depth of category. Used for tab indentation.
- * @param array $args Will only append content if style argument value is 'list'.
</del><ins>+ * @param int $depth Depth of category. Used for tab indentation.
+ * @param array $args An array of arguments. Will only append content if style argument value is 'list'.
+ * @wsee wp_list_categories()
</ins><span class="cx"> */
</span><span class="cx"> function end_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> if ( 'list' != $args['style'] )
</span><span class="lines">@@ -810,13 +822,17 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Start the element output.
+ *
</ins><span class="cx"> * @see Walker::start_el()
</span><ins>+ *
</ins><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param string $output Passed by reference. Used to append additional content.
</del><ins>+ * @param string $output Passed by reference. Used to append additional content.
</ins><span class="cx"> * @param object $category Category data object.
</span><del>- * @param int $depth Depth of category in reference to parents.
- * @param array $args
</del><ins>+ * @param int $depth Depth of category in reference to parents. Default 0.
+ * @param array $args An array of arguments. @see wp_list_categories()
+ * @param int $id ID of the current category.
</ins><span class="cx"> */
</span><span class="cx"> function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx"> extract($args);
</span><span class="lines">@@ -882,13 +898,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Ends the element output, if needed.
+ *
</ins><span class="cx"> * @see Walker::end_el()
</span><ins>+ *
</ins><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param object $page Not used.
- * @param int $depth Depth of category. Not used.
- * @param array $args Only uses 'list' for whether should append to output.
</del><ins>+ * @param object $page Not used.
+ * @param int $depth Depth of category. Not used.
+ * @param array $args An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
</ins><span class="cx"> */
</span><span class="cx"> function end_el( &$output, $page, $depth = 0, $args = array() ) {
</span><span class="cx"> if ( 'list' != $args['style'] )
</span><span class="lines">@@ -923,13 +942,15 @@
</span><span class="cx"> var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Start the element output.
+ *
</ins><span class="cx"> * @see Walker::start_el()
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param string $output Passed by reference. Used to append additional content.
</del><ins>+ * @param string $output Passed by reference. Used to append additional content.
</ins><span class="cx"> * @param object $category Category data object.
</span><del>- * @param int $depth Depth of category. Used for padding.
- * @param array $args Uses 'selected' and 'show_count' keys, if they exist.
</del><ins>+ * @param int $depth Depth of category. Used for padding.
+ * @param array $args Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories()
</ins><span class="cx"> */
</span><span class="cx"> function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx"> $pad = str_repeat(' ', $depth * 3);
</span></span></pre>
</div>
</div>
</body>
</html>