<!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>[25588] trunk/src/wp-includes/comment-template.php: Inline documentation for the Walker_Comment class in wp-includes/comment-template.php</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/25588">25588</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-09-23 23:28:41 +0000 (Mon, 23 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for the Walker_Comment class in wp-includes/comment-template.php
Fixes <a href="http://core.trac.wordpress.org/ticket/25388">#25388</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/comment-template.php (25587 => 25588)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/comment-template.php 2013-09-23 22:44:26 UTC (rev 25587)
+++ trunk/src/wp-includes/comment-template.php 2013-09-23 23:28:41 UTC (rev 25588)
</span><span class="lines">@@ -1473,21 +1473,30 @@
</span><span class="cx"> */
</span><span class="cx"> class Walker_Comment extends Walker {
</span><span class="cx"> /**
</span><ins>+ * What the class handles.
+ *
</ins><span class="cx"> * @see Walker::$tree_type
</span><ins>+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> * @var string
</span><span class="cx"> */
</span><span class="cx"> var $tree_type = 'comment';
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * DB fields to use.
+ *
</ins><span class="cx"> * @see Walker::$db_fields
</span><ins>+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> * @var array
</span><span class="cx"> */
</span><span class="cx"> var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Start the list before the elements are added.
+ *
</ins><span class="cx"> * @see Walker::start_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="lines">@@ -1511,12 +1520,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * End the list of items after the elements are added.
+ *
</ins><span class="cx"> * @see Walker::end_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 2.7.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 comment.
- * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
</del><ins>+ * @param int $depth Depth of comment.
+ * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
</ins><span class="cx"> */
</span><span class="cx"> function end_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> $GLOBALS['comment_depth'] = $depth + 1;
</span><span class="lines">@@ -1535,6 +1547,8 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Traverse elements to create list from elements.
+ *
</ins><span class="cx"> * This function is designed to enhance Walker::display_element() to
</span><span class="cx"> * display children of higher nesting levels than selected inline on
</span><span class="cx"> * the highest depth level displayed. This prevents them being orphaned
</span><span class="lines">@@ -1551,6 +1565,17 @@
</span><span class="cx"> * 2
</span><span class="cx"> * 2.2
</span><span class="cx"> *
</span><ins>+ * @see Walker::display_element()
+ *
+ * @since 2.7.0
+ *
+ * @param object $element Data object.
+ * @param array $children_elements List of elements to continue traversing.
+ * @param int $max_depth Max depth to traverse.
+ * @param int $depth Depth of current element.
+ * @param array $args An array of arguments. @see wp_list_comments()
+ * @param string $output Passed by reference. Used to append additional content.
+ * @return null Null on failure with no changes to parameters.
</ins><span class="cx"> */
</span><span class="cx"> function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
</span><span class="cx">
</span><span class="lines">@@ -1574,13 +1599,16 @@
</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.7.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 $comment Comment data object.
</span><del>- * @param int $depth Depth of comment in reference to parents.
- * @param array $args
</del><ins>+ * @param int $depth Depth of comment in reference to parents.
+ * @param array $args An array of arguments. @see wp_list_comments()
</ins><span class="cx"> */
</span><span class="cx"> function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx"> $depth++;
</span><span class="lines">@@ -1602,13 +1630,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.7.0
</span><span class="cx"> *
</span><del>- * @param string $output Passed by reference. Used to append additional content.
- * @param object $comment
- * @param int $depth Depth of comment.
- * @param array $args
</del><ins>+ * @param string $output Passed by reference. Used to append additional content.
+ * @param object $comment The comment object. Default current comment.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
</ins><span class="cx"> */
</span><span class="cx"> function end_el( &$output, $comment, $depth = 0, $args = array() ) {
</span><span class="cx"> if ( !empty( $args['end-callback'] ) ) {
</span><span class="lines">@@ -1622,12 +1653,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @since 3.6
</del><ins>+ * Output a pingback comment.
+ *
</ins><span class="cx"> * @access protected
</span><ins>+ * @since 3.6.0
</ins><span class="cx"> *
</span><del>- * @param object $comment
- * @param int $depth Depth of comment.
- * @param array $args
</del><ins>+ * @param object $comment The comment object.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
</ins><span class="cx"> */
</span><span class="cx"> protected function ping( $comment, $depth, $args ) {
</span><span class="cx"> $tag = ( 'div' == $args['style'] ) ? 'div' : 'li';
</span><span class="lines">@@ -1640,12 +1673,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @since 3.6
</del><ins>+ * Output a single comment.
+ *
</ins><span class="cx"> * @access protected
</span><ins>+ * @since 3.6.0
</ins><span class="cx"> *
</span><span class="cx"> * @param object $comment Comment to display.
</span><del>- * @param int $depth Depth of comment.
- * @param array $args Optional args.
</del><ins>+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
</ins><span class="cx"> */
</span><span class="cx"> protected function comment( $comment, $depth, $args ) {
</span><span class="cx"> if ( 'div' == $args['style'] ) {
</span><span class="lines">@@ -1688,12 +1723,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @since 3.6
</del><ins>+ * Output a comment in the HTML5 format.
+ *
</ins><span class="cx"> * @access protected
</span><ins>+ * @since 3.6.0
</ins><span class="cx"> *
</span><span class="cx"> * @param object $comment Comment to display.
</span><del>- * @param int $depth Depth of comment.
- * @param array $args Optional args.
</del><ins>+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
</ins><span class="cx"> */
</span><span class="cx"> protected function html5_comment( $comment, $depth, $args ) {
</span><span class="cx"> $tag = ( 'div' === $args['style'] ) ? 'div' : 'li';
</span></span></pre>
</div>
</div>
</body>
</html>