<!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>[27156] trunk/src/wp-includes/comment-template.php: Inline documentation cleanup 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/27156">27156</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-02-10 03:19:13 +0000 (Mon, 10 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation cleanup in wp-includes/comment-template.php.
This cleanup follows <a href="http://core.trac.wordpress.org/changeset/25567">[25567]</a> and brings the docs in-line with standards that at the time had not yet been finalized.
These changes include
* Moving in-line `@see` tags to their own lines
* Using docs-specific variables in hook docs
* Fixing line-wrapping throughout
* Typos and punctuation
* Converting hash notation values to variables per the standard
Fixes <a href="http://core.trac.wordpress.org/ticket/27083">#27083</a>. See <a href="http://core.trac.wordpress.org/ticket/20495">#20495</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 (27155 => 27156)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/comment-template.php 2014-02-10 01:11:25 UTC (rev 27155)
+++ trunk/src/wp-includes/comment-template.php 2014-02-10 03:19:13 UTC (rev 27156)
</span><span class="lines">@@ -76,7 +76,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $comment->comment_author_email The comment author's email address.
</del><ins>+ * @param string $comment_author_email The comment author's email address.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
</span><span class="cx"> }
</span><span class="lines">@@ -119,9 +119,10 @@
</span><span class="cx">
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link.Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
</del><ins>+ * @param string $linktext Optional. Text to display instead of the comment author's email address.
+ * Default empty.
+ * @param string $before Optional. Text or HTML to display before the email link.Default empty.
+ * @param string $after Optional. Text or HTML to display after the email link. Default empty.
</ins><span class="cx"> */
</span><span class="cx"> function comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
</span><span class="cx"> if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
</span><span class="lines">@@ -141,9 +142,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link. Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
</del><ins>+ * @param string $linktext Optional. Text to display instead of the comment author's email address.
+ * Default empty.
+ * @param string $before Optional. Text or HTML to display before the email link. Default empty.
+ * @param string $after Optional. Text or HTML to display after the email link. Default empty.
</ins><span class="cx"> */
</span><span class="cx"> function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
</span><span class="cx"> global $comment;
</span><span class="lines">@@ -151,11 +153,11 @@
</span><span class="cx"> * Filter the comment author's email for display.
</span><span class="cx"> *
</span><span class="cx"> * Care should be taken to protect the email address and assure that email
</span><del>- * harvesters do not capture your commentors' email address.
</del><ins>+ * harvesters do not capture your commenters' email address.
</ins><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $comment->comment_author_email The comment author's email address.
</del><ins>+ * @param string $comment_author_email The comment author's email address.
</ins><span class="cx"> */
</span><span class="cx"> $email = apply_filters( 'comment_email', $comment->comment_author_email );
</span><span class="cx"> if ((!empty($email)) && ($email != '@')) {
</span><span class="lines">@@ -177,7 +179,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the author's link. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to get the author's link.
+ * Default current comment.
</ins><span class="cx"> * @return string The comment author name or HTML link for author's URL.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_author_link( $comment_ID = 0 ) {
</span><span class="lines">@@ -194,7 +197,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $return The HTML-formatted comment author link. Empty for an invalid URL.
</del><ins>+ * @param string $return The HTML-formatted comment author link.
+ * Empty for an invalid URL.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_author_link', $return );
</span><span class="cx"> }
</span><span class="lines">@@ -203,9 +207,11 @@
</span><span class="cx"> * Display the html link to the url of the author of the current comment.
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><ins>+ *
</ins><span class="cx"> * @see get_comment_author_link() Echoes result
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to print the author's link. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to print the author's
+ * link. Default current comment.
</ins><span class="cx"> */
</span><span class="cx"> function comment_author_link( $comment_ID = 0 ) {
</span><span class="cx"> echo get_comment_author_link( $comment_ID );
</span><span class="lines">@@ -216,8 +222,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the author's IP address. Default current comment.
- * @return string The comment author's IP address.
</del><ins>+ * @param int $comment_ID ID of the comment for which to get the author's IP
+ * address. Default current comment.
+ * @return string Comment author's IP address.
</ins><span class="cx"> */
</span><span class="cx"> function get_comment_author_IP( $comment_ID = 0 ) {
</span><span class="cx"> $comment = get_comment( $comment_ID );
</span><span class="lines">@@ -227,7 +234,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $comment->comment_author_IP The comment author's IP address.
</del><ins>+ * @param string $comment_author_IP The comment author's IP address.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );
</span><span class="cx"> }
</span><span class="lines">@@ -237,7 +244,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to print the author's IP address. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to print the author's IP
+ * address. Default current comment.
</ins><span class="cx"> */
</span><span class="cx"> function comment_author_IP( $comment_ID = 0 ) {
</span><span class="cx"> echo get_comment_author_IP( $comment_ID );
</span><span class="lines">@@ -248,7 +256,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the author's URL. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to get the author's URL.
+ * Default current comment.
</ins><span class="cx"> * @return string
</span><span class="cx"> */
</span><span class="cx"> function get_comment_author_url( $comment_ID = 0 ) {
</span><span class="lines">@@ -270,7 +279,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to print the author's URL. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to print the author's URL.
+ * Default current comment.
</ins><span class="cx"> */
</span><span class="cx"> function comment_author_url( $comment_ID = 0 ) {
</span><span class="cx"> $author_url = get_comment_author_url( $comment_ID );
</span><span class="lines">@@ -296,9 +306,12 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link. Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
</del><ins>+ * @param string $linktext Optional. The text to display instead of the comment
+ * author's email address. Default empty.
+ * @param string $before Optional. The text or HTML to display before the email link.
+ * Default empty.
+ * @param string $after Optional. The text or HTML to display after the email link.
+ * Default empty.
</ins><span class="cx"> * @return string The HTML link between the $before and $after parameters.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
</span><span class="lines">@@ -325,23 +338,28 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link. Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
</del><ins>+ * @param string $linktext Optional. Text to display instead of the comment author's
+ * email address. Default empty.
+ * @param string $before Optional. Text or HTML to display before the email link.
+ * Default empty.
+ * @param string $after Optional. Text or HTML to display after the email link.
+ * Default empty.
</ins><span class="cx"> */
</span><span class="cx"> function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
</span><span class="cx"> echo get_comment_author_url_link( $linktext, $before, $after );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Generates semantic classes for each comment element
</del><ins>+ * Generates semantic classes for each comment element.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
- * @param int $comment_id Optional. Comment ID. Default current comment.
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @param bool $echo Optional. Whether comment_class should echo or return. Default true.
</del><ins>+ * @param string|array $class Optional. One or more classes to add to the class list.
+ * Default empty.
+ * @param int $comment_id Comment ID. Default current comment.
+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
+ * @param bool $echo Optional. Whether to cho or return the output.
+ * Default true.
</ins><span class="cx"> */
</span><span class="cx"> function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
</span><span class="cx"> // Separates classes with a single space, collates classes for comment DIV
</span><span class="lines">@@ -353,13 +371,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns the classes for the comment div as an array
</del><ins>+ * Returns the classes for the comment div as an array.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><span class="cx"> * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
</span><del>- * @param int $comment_id Optional. Comment ID. Default current comment.
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
</del><ins>+ * @param int $comment_id Comment ID. Default current comment.
+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</ins><span class="cx"> * @return array An array of classes.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
</span><span class="lines">@@ -440,7 +458,7 @@
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $d Optional. The format of the date. Default user's setting.
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the date. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to get the date. Default current comment.
</ins><span class="cx"> * @return string The comment's date.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_date( $d = '', $comment_ID = 0 ) {
</span><span class="lines">@@ -466,7 +484,7 @@
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><span class="cx"> * @param string $d Optional. The format of the date. Default user's settings.
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to print the date. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to print the date. Default current comment.
</ins><span class="cx"> */
</span><span class="cx"> function comment_date( $d = '', $comment_ID = 0 ) {
</span><span class="cx"> echo get_comment_date( $d, $comment_ID );
</span><span class="lines">@@ -481,7 +499,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the excerpt. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to get the excerpt.
+ * Default current comment.
</ins><span class="cx"> * @return string The maybe truncated comment with 20 words or less.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_excerpt( $comment_ID = 0 ) {
</span><span class="lines">@@ -508,7 +527,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to print the excerpt. Default current comment.
</del><ins>+ * @param int $comment_ID ID of the comment for which to print the excerpt.
+ * Default current comment.
</ins><span class="cx"> */
</span><span class="cx"> function comment_excerpt( $comment_ID = 0 ) {
</span><span class="cx"> $comment_excerpt = get_comment_excerpt($comment_ID);
</span><span class="lines">@@ -536,7 +556,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment->comment_ID The current comment ID.
</del><ins>+ * @param int $comment_ID The current comment ID.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_ID', $comment->comment_ID );
</span><span class="cx"> }
</span><span class="lines">@@ -555,8 +575,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param mixed $comment Optional. Comment to retrieve. Default current comment.
- * @param array $args Optional. An array of arguments to override the defaults. @see get_page_of_comment()
</del><ins>+ * @see get_page_of_comment()
+ *
+ * @param mixed $comment Comment to retrieve. Default current comment.
+ * @param array $args Optional. An array of arguments to override the defaults.
</ins><span class="cx"> * @return string The permalink to the given comment.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_link( $comment = null, $args = array() ) {
</span><span class="lines">@@ -600,9 +622,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><ins>+ * @see get_page_of_comment()
+ *
</ins><span class="cx"> * @param string $link The comment permalink with '#comment-$id' appended.
</span><span class="cx"> * @param object $comment The current comment object.
</span><del>- * @param array $args An array of arguments to override the defaults. @see get_page_of_comment()
</del><ins>+ * @param array $args An array of arguments to override the defaults.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_link', $link, $comment, $args );
</span><span class="cx"> }
</span><span class="lines">@@ -612,7 +636,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
</del><ins>+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</ins><span class="cx"> * @return string The link to the comments.
</span><span class="cx"> */
</span><span class="cx"> function get_comments_link( $post_id = 0 ) {
</span><span class="lines">@@ -622,8 +646,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since
</span><span class="cx"> *
</span><del>- * @param string $comments_link The post comments permalink with '#comments' appended.
- * @param int|WP_Post $post_id The post ID or WP_Post object.
</del><ins>+ * @param string $comments_link Post comments permalink with '#comments' appended.
+ * @param int|WP_Post $post_id Post ID or WP_Post object.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comments_link', $comments_link, $post_id );
</span><span class="cx"> }
</span><span class="lines">@@ -649,7 +673,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
</del><ins>+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</ins><span class="cx"> * @return int The number of comments a post has.
</span><span class="cx"> */
</span><span class="cx"> function get_comments_number( $post_id = 0 ) {
</span><span class="lines">@@ -669,8 +693,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $count The number of comments a post has.
- * @param int|WP_Post $post_id The post ID or WP_Post object.
</del><ins>+ * @param int $count Nnumber of comments a post has.
+ * @param int|WP_Post $post_id Post ID or WP_Post object.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comments_number', $count, $post_id );
</span><span class="cx"> }
</span><span class="lines">@@ -703,7 +727,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n()
</del><ins>+ * @see _n()
+ *
+ * @param string $output A translatable string formatted based on whether the count
+ * is equal to 0, 1, or 1+.
</ins><span class="cx"> * @param int $number The number of post comments.
</span><span class="cx"> */
</span><span class="cx"> echo apply_filters( 'comments_number', $output, $number );
</span><span class="lines">@@ -714,8 +741,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the text. Default current comment.
- * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
</del><ins>+ * @see Walker_Comment::comment()
+ *
+ * @param int $comment_ID ID of the comment for which to get the text. Default current comment.
+ * @param array $args Optional. An array of arguments. Default empty.
</ins><span class="cx"> * @return string The comment content.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_text( $comment_ID = 0, $args = array() ) {
</span><span class="lines">@@ -726,9 +755,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $comment->comment_content The text of the comment.
- * @param object $comment The comment object.
- * @param array $args An array of arguments. @see Walker_Comment::comment()
</del><ins>+ * @see Walker_Comment::comment()
+ *
+ * @param string $comment_content Text of the comment.
+ * @param object $comment The comment object.
+ * @param array $args An array of arguments.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );
</span><span class="cx"> }
</span><span class="lines">@@ -738,10 +769,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to print the text.
- * Default 0.
- * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
- * Default empty array.
</del><ins>+ * @see Walker_Comment::comment()
+ *
+ * @param int $comment_ID ID of the comment for which to print the text. Default 0.
+ * @param array $args Optional. An array of arguments. Default empty array. Default empty.
</ins><span class="cx"> */
</span><span class="cx"> function comment_text( $comment_ID = 0, $args = array() ) {
</span><span class="cx"> $comment = get_comment( $comment_ID );
</span><span class="lines">@@ -752,9 +783,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $comment_text The text of the current comment.
</del><ins>+ * @see Walker_Comment::comment()
+ *
+ * @param string $comment_text Text of the current comment.
</ins><span class="cx"> * @param object $comment The comment object.
</span><del>- * @param array $args An array of arguments. @see Walker_Comment::comment()
</del><ins>+ * @param array $args An array of arguments.
</ins><span class="cx"> */
</span><span class="cx"> echo apply_filters( 'comment_text', $comment_text, $comment, $args );
</span><span class="cx"> }
</span><span class="lines">@@ -766,8 +799,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $d Optional. The format of the time. Default user's settings.
</span><span class="cx"> * @param bool $gmt Optional. Whether to use the GMT date. Default false.
</span><del>- * @param bool $translate Optional. Whether to translate the time (for use in feeds). Default true.
- * @return string The formatted time
</del><ins>+ * @param bool $translate Optional. Whether to translate the time (for use in feeds).
+ * Default true.
+ * @return string The formatted time.
</ins><span class="cx"> */
</span><span class="cx"> function get_comment_time( $d = '', $gmt = false, $translate = true ) {
</span><span class="cx"> global $comment;
</span><span class="lines">@@ -783,7 +817,7 @@
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><span class="cx"> * @param string|int $date The comment time, formatted as a date string or Unix timestamp.
</span><del>- * @param string $d The date format.
</del><ins>+ * @param string $d Date format.
</ins><span class="cx"> * @param bool $gmt Whether the GMT date is in use.
</span><span class="cx"> * @param bool $translate Whether the time is translated.
</span><span class="cx"> */
</span><span class="lines">@@ -806,8 +840,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int $comment_ID Optional. The ID of the comment for which to get the type. Default current comment.
- * @return string The comment type
</del><ins>+ * @param int $comment_ID ID of the comment for which to get the type. Default current comment.
+ * @return string The comment type.
</ins><span class="cx"> */
</span><span class="cx"> function get_comment_type( $comment_ID = 0 ) {
</span><span class="cx"> $comment = get_comment( $comment_ID );
</span><span class="lines">@@ -819,7 +853,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
</del><ins>+ * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'get_comment_type', $comment->comment_type );
</span><span class="cx"> }
</span><span class="lines">@@ -829,9 +863,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param string $commenttxt Optional. The string to display for comment type. Default false.
- * @param string $trackbacktxt Optional. The string to display for trackback type. Default false.
- * @param string $pingbacktxt Optional. The string to display for pingback type. Default false.
</del><ins>+ * @param string $commenttxt Optional. String to display for comment type. Default false.
+ * @param string $trackbacktxt Optional. String to display for trackback type. Default false.
+ * @param string $pingbacktxt Optional. String to display for pingback type. Default false.
</ins><span class="cx"> */
</span><span class="cx"> function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) {
</span><span class="cx"> if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
</span><span class="lines">@@ -883,7 +917,8 @@
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><span class="cx"> * @param bool $deprecated_echo Not used.
</span><del>- * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
</del><ins>+ * @return void|string Should only be used to echo the trackback URL, use get_trackback_url()
+ * for the result instead.
</ins><span class="cx"> */
</span><span class="cx"> function trackback_url( $deprecated_echo = true ) {
</span><span class="cx"> if ( $deprecated_echo !== true )
</span><span class="lines">@@ -929,7 +964,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
</del><ins>+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</ins><span class="cx"> * @return bool True if the comments are open.
</span><span class="cx"> */
</span><span class="cx"> function comments_open( $post_id = null ) {
</span><span class="lines">@@ -954,7 +989,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
</del><ins>+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</ins><span class="cx"> * @return bool True if pings are accepted
</span><span class="cx"> */
</span><span class="cx"> function pings_open( $post_id = null ) {
</span><span class="lines">@@ -1011,7 +1046,8 @@
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $file Optional. The file to load. Default '/comments.php'.
</span><del>- * @param bool $separate_comments Optional. Whether to separate the comments by comment type. Default false.
</del><ins>+ * @param bool $separate_comments Optional. Whether to separate the comments by comment type.
+ * Default false.
</ins><span class="cx"> * @return null Returns null if no comments appear.
</span><span class="cx"> */
</span><span class="cx"> function comments_template( $file = '/comments.php', $separate_comments = false ) {
</span><span class="lines">@@ -1025,24 +1061,25 @@
</span><span class="cx">
</span><span class="cx"> $req = get_option('require_name_email');
</span><span class="cx">
</span><del>- /**
</del><ins>+ /*
</ins><span class="cx"> * Comment author information fetched from the comment cookies.
</span><del>- *
- * @uses wp_get_current_commenter()
</del><ins>+ * Uuses wp_get_current_commenter().
</ins><span class="cx"> */
</span><span class="cx"> $commenter = wp_get_current_commenter();
</span><span class="cx">
</span><del>- /**
</del><ins>+ /*
</ins><span class="cx"> * The name of the current comment author escaped for use in attributes.
</span><ins>+ * Escaped by sanitize_comment_cookies().
</ins><span class="cx"> */
</span><del>- $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
</del><ins>+ $comment_author = $commenter['comment_author'];
</ins><span class="cx">
</span><del>- /**
</del><ins>+ /*
</ins><span class="cx"> * The email address of the current comment author escaped for use in attributes.
</span><ins>+ * Escaped by sanitize_comment_cookies().
</ins><span class="cx"> */
</span><del>- $comment_author_email = $commenter['comment_author_email']; // Escaped by sanitize_comment_cookies()
</del><ins>+ $comment_author_email = $commenter['comment_author_email'];
</ins><span class="cx">
</span><del>- /**
</del><ins>+ /*
</ins><span class="cx"> * The url of the current comment author escaped for use in attributes.
</span><span class="cx"> */
</span><span class="cx"> $comment_author_url = esc_url($commenter['comment_author_url']);
</span><span class="lines">@@ -1056,14 +1093,13 @@
</span><span class="cx"> $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND ( comment_approved = '1' OR ( comment_author = %s AND comment_author_email = %s AND comment_approved = '0' ) ) ORDER BY comment_date_gmt", $post->ID, wp_specialchars_decode($comment_author,ENT_QUOTES), $comment_author_email));
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // keep $comments for legacy's sake
</del><span class="cx"> /**
</span><span class="cx"> * Filter the comments array.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param array $comments The array of comments supplied to the comments template.
- * @param int $post->ID The post ID.
</del><ins>+ * @param array $comments Array of comments supplied to the comments template.
+ * @param int $post_ID Post ID.
</ins><span class="cx"> */
</span><span class="cx"> $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
</span><span class="cx"> $comments = &$wp_query->comments;
</span><span class="lines">@@ -1136,19 +1172,22 @@
</span><span class="cx"> /**
</span><span class="cx"> * Displays the link to the comments popup window for the current post ID.
</span><span class="cx"> *
</span><del>- * Is not meant to be displayed on single posts and pages. Should be used on the
- * lists of posts
</del><ins>+ * Is not meant to be displayed on single posts and pages. Should be used
+ * on the lists of posts
</ins><span class="cx"> *
</span><span class="cx"> * @global string $wpcommentspopupfile The URL to use for the popup window.
</span><span class="cx"> * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called.
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param string $zero Optional. The string to display when no comments. Default false.
- * @param string $one Optional. The string to display when only one comment is available. Default false.
- * @param string $more Optional. The string to display when there are more than one comment. Default false.
- * @param string $css_class Optional. The CSS class to use for comments. Default empty.
- * @param string $none Optional. The string to display when comments have been turned off. Default false.
</del><ins>+ * @param string $zero Optional. String to display when no comments. Default false.
+ * @param string $one Optional. String to display when only one comment is available.
+ * Default false.
+ * @param string $more Optional. String to display when there are more than one comment.
+ * Default false.
+ * @param string $css_class Optional. CSS class to use for comments. Default empty.
+ * @param string $none Optional. String to display when comments have been turned off.
+ * Default false.
</ins><span class="cx"> * @return null Returns null on single posts and pages.
</span><span class="cx"> */
</span><span class="cx"> function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
</span><span class="lines">@@ -1217,21 +1256,22 @@
</span><span class="cx"> * @param array $args {
</span><span class="cx"> * Optional. Override default arguments.
</span><span class="cx"> *
</span><del>- * @type string 'add_below' The first part of the selector used to identify the comment to respond below. The resulting
- * value is passed as the first parameter to addComment.moveForm(), concatenated
- * as $add_below-$comment->comment_ID. Default 'comment'.
- * @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(),
- * and appended to the link URL as a hash value. Default 'respond'.
- * @type string 'reply_text' The text of the Reply link. Default 'Reply'.
- * @type string 'login_text' The text of the link to reply if logged out. Default 'Log in to Reply'.
- * @type int 'depth' The depth of the new comment. Must be greater than 0 and less than the value of the 'thread_comments_depth'
- * option set in Settings > Discussion.
- * Default 0.
- * @type string 'before' The text or HTML to add before the reply link. Default empty.
- * @type string 'after' The text or HTML to add after the reply link. Default empty.
</del><ins>+ * @type string $add_below The first part of the selector used to identify the comment to respond below.
+ * The resulting value is passed as the first parameter to addComment.moveForm(),
+ * concatenated as $add_below-$comment->comment_ID. Default 'comment'.
+ * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
+ * to addComment.moveForm(), and appended to the link URL as a hash value.
+ * Default 'respond'.
+ * @type string $reply_text The text of the Reply link. Default 'Reply'.
+ * @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'.
+ * @type int $depth' The depth of the new comment. Must be greater than 0 and less than the value
+ * of the 'thread_comments_depth' option set in Settings > Discussion. Default 0.
+ * @type string $before The text or HTML to add before the reply link. Default empty.
+ * @type string $after The text or HTML to add after the reply link. Default empty.
</ins><span class="cx"> * }
</span><del>- * @param int $comment Optional. Comment being replied to. Default current comment.
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
</del><ins>+ * @param int $comment Comment being replied to. Default current comment.
+ * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
+ * Default current post.
</ins><span class="cx"> * @return mixed Link to show comment form, if successful. False, if comments are closed.
</span><span class="cx"> */
</span><span class="cx"> function get_comment_reply_link($args = array(), $comment = null, $post = null) {
</span><span class="lines">@@ -1273,9 +1313,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string $before Text or HTML displayed before the reply link.
</del><span class="cx"> * @param string $link The HTML markup for the comment reply link.
</span><del>- * @param string $after Text or HTML displayed after the reply link.
</del><span class="cx"> * @param array $args An array of arguments overriding the defaults.
</span><span class="cx"> * @param object $comment The object of the comment being replied.
</span><span class="cx"> * @param WP_Post $post The WP_Post object.
</span><span class="lines">@@ -1288,9 +1326,12 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param array $args Optional. Override default options, @see get_comment_reply_link()
- * @param int $comment Optional. Comment being replied to. Default current comment.
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
</del><ins>+ * @see get_comment_reply_link()
+ *
+ * @param array $args Optional. Override default options.
+ * @param int $comment Comment being replied to. Default current comment.
+ * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
+ * Default current post.
</ins><span class="cx"> * @return mixed Link to show comment form, if successful. False, if comments are closed.
</span><span class="cx"> */
</span><span class="cx"> function comment_reply_link($args = array(), $comment = null, $post = null) {
</span><span class="lines">@@ -1305,17 +1346,19 @@
</span><span class="cx"> * @param array $args {
</span><span class="cx"> * Optional. Override default arguments.
</span><span class="cx"> *
</span><del>- * @type string 'add_below' The first part of the selector used to identify the comment to respond below.
- * The resulting value is passed as the first parameter to addComment.moveForm(),
- * concatenated as $add_below-$comment->comment_ID. Default is 'post'.
- * @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter
- * to addComment.moveForm(), and appended to the link URL as a hash value. Default is 'respond'.
- * @type string 'reply_text' The text of the Reply link. Default is 'Leave a Comment'.
- * @type string 'login_text' The text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
- * @type string 'before' The text or HTML to add before the reply link. Default empty.
- * @type string 'after' The text or HTML to add after the reply link. Default empty.
</del><ins>+ * @type string $add_below The first part of the selector used to identify the comment to respond below.
+ * The resulting value is passed as the first parameter to addComment.moveForm(),
+ * concatenated as $add_below-$comment->comment_ID. Default is 'post'.
+ * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
+ * to addComment.moveForm(), and appended to the link URL as a hash value.
+ * Default 'respond'.
+ * @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'.
+ * @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
+ * @type string $before Text or HTML to add before the reply link. Default empty.
+ * @type string $after Text or HTML to add after the reply link. Default empty.
</ins><span class="cx"> * }
</span><del>- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
</del><ins>+ * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
+ * Default current post.
</ins><span class="cx"> * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
</span><span class="cx"> */
</span><span class="cx"> function get_post_reply_link($args = array(), $post = null) {
</span><span class="lines">@@ -1357,8 +1400,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param array $args Optional. Override default options, @see get_post_reply_link()
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
</del><ins>+ * @see get_post_reply_link()
+ *
+ * @param array $args Optional. Override default options,
+ * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
+ * Default current post.
</ins><span class="cx"> * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
</span><span class="cx"> */
</span><span class="cx"> function post_reply_link($args = array(), $post = null) {
</span><span class="lines">@@ -1386,8 +1432,8 @@
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $formatted_link The HTML-formatted cancel comment reply link.
</span><del>- * @param string $link The cancel comment reply link URL.
- * @param string $text The cancel comment reply link text.
</del><ins>+ * @param string $link Cancel comment reply link URL.
+ * @param string $text Cancel comment reply link text.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'cancel_comment_reply_link', $formatted_link, $link, $text );
</span><span class="cx"> }
</span><span class="lines">@@ -1449,10 +1495,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string $noreplytext Optional. Text to display when not replying to a comment. Default false.
</del><ins>+ * @param string $noreplytext Optional. Text to display when not replying to a comment.
+ * Default false.
</ins><span class="cx"> * @param string $replytext Optional. Text to display when replying to a comment.
</span><del>- * Default false. Accepts "%s" for the author of the comment being replied to.
- * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment. Default true.
</del><ins>+ * Default false. Accepts "%s" for the author of the comment
+ * being replied to.
+ * @param string $linktoparent Optional. Boolean to control making the author's name a link
+ * to their comment. Default true.
</ins><span class="cx"> */
</span><span class="cx"> function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
</span><span class="cx"> global $comment;
</span><span class="lines">@@ -1573,6 +1622,7 @@
</span><span class="cx"> * 2.2
</span><span class="cx"> *
</span><span class="cx"> * @see Walker::display_element()
</span><ins>+ * @see wp_list_comments()
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><span class="lines">@@ -1580,7 +1630,7 @@
</span><span class="cx"> * @param array $children_elements List of elements to continue traversing.
</span><span class="cx"> * @param int $max_depth Max depth to traverse.
</span><span class="cx"> * @param int $depth Depth of current element.
</span><del>- * @param array $args An array of arguments. @see wp_list_comments()
</del><ins>+ * @param array $args An array of arguments.
</ins><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx"> * @return null Null on failure with no changes to parameters.
</span><span class="cx"> */
</span><span class="lines">@@ -1608,14 +1658,15 @@
</span><span class="cx"> /**
</span><span class="cx"> * Start the element output.
</span><span class="cx"> *
</span><ins>+ * @since 2.7.0
+ *
</ins><span class="cx"> * @see Walker::start_el()
</span><ins>+ * @see wp_list_comments()
</ins><span class="cx"> *
</span><del>- * @since 2.7.0
- *
</del><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx"> * @param object $comment Comment data object.
</span><span class="cx"> * @param int $depth Depth of comment in reference to parents.
</span><del>- * @param array $args An array of arguments. @see wp_list_comments()
</del><ins>+ * @param array $args An array of arguments.
</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">@@ -1647,14 +1698,15 @@
</span><span class="cx"> /**
</span><span class="cx"> * Ends the element output, if needed.
</span><span class="cx"> *
</span><ins>+ * @since 2.7.0
+ *
</ins><span class="cx"> * @see Walker::end_el()
</span><ins>+ * @see wp_list_comments()
</ins><span class="cx"> *
</span><del>- * @since 2.7.0
- *
</del><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx"> * @param object $comment The comment object. Default current comment.
</span><span class="cx"> * @param int $depth Depth of comment.
</span><del>- * @param array $args An array of arguments. @see wp_list_comments()
</del><ins>+ * @param array $args An array of arguments.
</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">@@ -1675,9 +1727,11 @@
</span><span class="cx"> * @access protected
</span><span class="cx"> * @since 3.6.0
</span><span class="cx"> *
</span><ins>+ * @see wp_list_comments()
+ *
</ins><span class="cx"> * @param object $comment The comment object.
</span><span class="cx"> * @param int $depth Depth of comment.
</span><del>- * @param array $args An array of arguments. @see wp_list_comments()
</del><ins>+ * @param array $args An array of arguments.
</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">@@ -1695,9 +1749,11 @@
</span><span class="cx"> * @access protected
</span><span class="cx"> * @since 3.6.0
</span><span class="cx"> *
</span><ins>+ * @see wp_list_comments()
+ *
</ins><span class="cx"> * @param object $comment Comment to display.
</span><span class="cx"> * @param int $depth Depth of comment.
</span><del>- * @param array $args An array of arguments. @see wp_list_comments()
</del><ins>+ * @param array $args An array of arguments.
</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">@@ -1745,9 +1801,11 @@
</span><span class="cx"> * @access protected
</span><span class="cx"> * @since 3.6.0
</span><span class="cx"> *
</span><ins>+ * @see wp_list_comments()
+ *
</ins><span class="cx"> * @param object $comment Comment to display.
</span><span class="cx"> * @param int $depth Depth of comment.
</span><del>- * @param array $args An array of arguments. @see wp_list_comments()
</del><ins>+ * @param array $args An array of arguments.
</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 class="lines">@@ -1793,27 +1851,29 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><ins>+ * @see WP_Query->comments
+ *
</ins><span class="cx"> * @param string|array $args {
</span><span class="cx"> * Optional. Formatting options.
</span><span class="cx"> *
</span><del>- * @type string 'walker' The Walker class used to list comments. Default null.
- * @type int 'max_depth' The maximum comments depth. Default empty.
- * @type string 'style' The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.
- * @type string 'callback' Callback function to use. Default null.
- * @type string 'end-callback' Callback function to use at the end. Default null.
- * @type string 'type' Type of comments to list.
- * Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
- * @type int 'page' Page ID to list comments for. Default empty.
- * @type int 'per_page' Number of comments to list per page. Default empty.
- * @type int 'avatar_size' Height and width dimensions of the avatar size. Default 32.
- * @type string 'reverse_top_level' Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.
- * @type bool 'reverse_children' Whether to reverse child comments in the list. Default null.
- * @type string 'format' How to format the comments list.
- * Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'.
- * @type bool 'short_ping' Whether to output short pings. Default false.
- * @type bool 'echo' Whether to echo the output or return it. Default true.
</del><ins>+ * @type string $walker The Walker class used to list comments. Default null.
+ * @type int $max_depth The maximum comments depth. Default empty.
+ * @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.
+ * @type string $callback Callback function to use. Default null.
+ * @type string $end-callback Callback function to use at the end. Default null.
+ * @type string $type Type of comments to list.
+ * Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
+ * @type int $page Page ID to list comments for. Default empty.
+ * @type int $per_page Number of comments to list per page. Default empty.
+ * @type int $avatar_size Height and width dimensions of the avatar size. Default 32.
+ * @type string $reverse_top_level Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.
+ * @type bool $reverse_children Whether to reverse child comments in the list. Default null.
+ * @type string $format How to format the comments list.
+ * Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'.
+ * @type bool $short_ping Whether to output short pings. Default false.
+ * @type bool $echo Whether to echo the output or return it. Default true.
</ins><span class="cx"> * }
</span><del>- * @param array $comments Optional. Array of comment objects. @see WP_Query->comments
</del><ins>+ * @param array $comments Optional. Array of comment objects.
</ins><span class="cx"> */
</span><span class="cx"> function wp_list_comments( $args = array(), $comments = null ) {
</span><span class="cx"> global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
</span><span class="lines">@@ -1932,30 +1992,30 @@
</span><span class="cx"> * @param array $args {
</span><span class="cx"> * Optional. Default arguments and form fields to override.
</span><span class="cx"> *
</span><del>- * @type array 'fields' {
</del><ins>+ * @type array $fields {
</ins><span class="cx"> * Default comment fields, filterable by default via the 'comment_form_default_fields' hook.
</span><span class="cx"> *
</span><del>- * @type string 'author' The comment author field HTML.
- * @type string 'email' The comment author email field HTML.
- * @type string 'url' The comment author URL field HTML.
</del><ins>+ * @type string $author Comment author field HTML.
+ * @type string $email Comment author email field HTML.
+ * @type string $url Comment author URL field HTML.
</ins><span class="cx"> * }
</span><del>- * @type string 'comment_field' The comment textarea field HTML.
- * @type string 'must_log_in' HTML element for a 'must be logged in to comment' message.
- * @type string 'logged_in_as' HTML element for a 'logged in as <user>' message.
- * @type string 'comment_notes_before' HTML element for a message displayed before the comment form.
- * Default 'Your email address will not be published.'.
- * @type string 'comment_notes_after' HTML element for a message displayed after the comment form.
- * Default 'You may use these HTML tags and attributes ...'.
- * @type string 'id_form' The comment form element id attribute. Default 'commentform'.
- * @type string 'id_submit' The comment submit element id attribute. Default 'submit'.
- * @type string 'title_reply' The translatable 'reply' button label. Default 'Leave a Reply'.
- * @type string 'title_reply_to' The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
- * where %s is the author of the comment being replied to.
- * @type string 'cancel_reply_link' The translatable 'cancel reply' button label. Default 'Cancel reply'.
- * @type string 'label_submit' The translatable 'submit' button label. Default 'Post a comment'.
- * @type string 'format' The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
</del><ins>+ * @type string $comment_field The comment textarea field HTML.
+ * @type string $must_log_in HTML element for a 'must be logged in to comment' message.
+ * @type string $logged_in_as HTML element for a 'logged in as <user>' message.
+ * @type string $comment_notes_before HTML element for a message displayed before the comment form.
+ * Default 'Your email address will not be published.'.
+ * @type string $comment_notes_after HTML element for a message displayed after the comment form.
+ * Default 'You may use these HTML tags and attributes ...'.
+ * @type string $id_form The comment form element id attribute. Default 'commentform'.
+ * @type string $id_submit The comment submit element id attribute. Default 'submit'.
+ * @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'.
+ * @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
+ * where %s is the author of the comment being replied to.
+ * @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'.
+ * @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'.
+ * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
</ins><span class="cx"> * }
</span><del>- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object to generate the form for. Default current post.
</del><ins>+ * @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post.
</ins><span class="cx"> */
</span><span class="cx"> function comment_form( $args = array(), $post_id = null ) {
</span><span class="cx"> if ( null === $post_id )
</span><span class="lines">@@ -2059,9 +2119,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param string $args['logged_in_as'] The logged-in-as HTML-formatted message.
- * @param array $commenter An array containing the comment author's username, email, and URL.
- * @param string $user_identity If the commenter is a registered user, the display name, blank otherwise.
</del><ins>+ * @param string $args_logged_in The logged-in-as HTML-formatted message.
+ * @param array $commenter An array containing the comment author's
+ * username, email, and URL.
+ * @param string $user_identity If the commenter is a registered user,
+ * the display name, blank otherwise.
</ins><span class="cx"> */
</span><span class="cx"> echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity );
</span><span class="cx"> ?>
</span><span class="lines">@@ -2071,8 +2133,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param array $commenter An array containing the comment author's username, email, and URL.
- * @param string $user_identity If the commenter is a registered user, the display name, blank otherwise.
</del><ins>+ * @param array $commenter An array containing the comment author's
+ * username, email, and URL.
+ * @param string $user_identity If the commenter is a registered user,
+ * the display name, blank otherwise.
</ins><span class="cx"> */
</span><span class="cx"> do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
</span><span class="cx"> ?>
</span><span class="lines">@@ -2112,7 +2176,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param string $args['comment_field'] The content of the comment textarea field.
</del><ins>+ * @param string $args_comment_field The content of the comment textarea field.
</ins><span class="cx"> */
</span><span class="cx"> echo apply_filters( 'comment_form_field_comment', $args['comment_field'] );
</span><span class="cx"> ?>
</span></span></pre>
</div>
</div>
</body>
</html>