<!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>[25428] trunk/src/wp-includes/comment-template.php: Inline documentation for get_comment_reply_link() and 'comment_reply_link' filter.</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/25428">25428</a></dd>
<dt>Author</dt> <dd>SergeyBiryukov</dd>
<dt>Date</dt> <dd>2013-09-13 19:19:45 +0000 (Fri, 13 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for get_comment_reply_link() and 'comment_reply_link' filter.
props DrewAPicture.
fixes <a href="http://core.trac.wordpress.org/ticket/25310">#25310</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 (25427 => 25428)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/comment-template.php 2013-09-13 12:52:28 UTC (rev 25427)
+++ trunk/src/wp-includes/comment-template.php 2013-09-13 19:19:45 UTC (rev 25428)
</span><span class="lines">@@ -1018,25 +1018,42 @@
</span><span class="cx"> /**
</span><span class="cx"> * Retrieve HTML content for reply to comment link.
</span><span class="cx"> *
</span><del>- * The default arguments that can be override are 'add_below', 'respond_id',
- * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
- * used, if the user must log in or register first before posting a comment. The
- * 'reply_text' will be used, if they can post a reply. The 'add_below' and
- * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
- * parameters.
- *
</del><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param array $args Optional. Override default options.
</del><ins>+ * @param array $args {
+ * Override default options.
+ *
+ * @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 '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 is 'respond'.
+ * @type string 'reply_text' The text of the Reply link.
+ * Default is 'Reply'.
+ * @type string 'login_text' The text of the link to reply if logged out.
+ * Default is '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 is 0.
+ * @type string 'before' The text or HTML to add before the reply link.
+ * Default empty string.
+ * @type string 'after' The text or HTML to add after the reply link.
+ * Default empty string.
+ * }
</ins><span class="cx"> * @param int $comment Optional. Comment being replied to.
</span><del>- * @param int $post Optional. Post that the comment is going to be displayed on.
</del><ins>+ * @param int $post Optional. Post that the comment is going to be displayed on.
</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_comment_reply_link($args = array(), $comment = null, $post = null) {
</span><span class="cx"> global $user_ID;
</span><span class="cx">
</span><del>- $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'),
- 'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => '');
</del><ins>+ $defaults = array(
+ 'add_below' => 'comment',
+ 'respond_id' => 'respond',
+ 'reply_text' => __('Reply'),
+ 'login_text' => __('Log in to Reply'),
+ 'depth' => 0,
+ 'before' => '',
+ 'after' => ''
+ );
</ins><span class="cx">
</span><span class="cx"> $args = wp_parse_args($args, $defaults);
</span><span class="cx">
</span><span class="lines">@@ -1059,7 +1076,20 @@
</span><span class="cx"> $link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url( wp_login_url( get_permalink() ) ) . '">' . $login_text . '</a>';
</span><span class="cx"> else
</span><span class="cx"> $link = "<a class='comment-reply-link' href='" . esc_url( add_query_arg( 'replytocom', $comment->comment_ID ) ) . "#" . $respond_id . "' onclick='return addComment.moveForm(\"$add_below-$comment->comment_ID\", \"$comment->comment_ID\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
</span><del>- return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post);
</del><ins>+
+ /**
+ * Filter the comment reply link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $before Text or HTML displayed before the reply link.
+ * @param string $link The HTML markup for the comment reply link.
+ * @param string $after Text or HTML displayed after the reply link.
+ * @param array $args An array of arguments overriding the defaults.
+ * @param object $comment The object of the comment being replied.
+ * @param WP_Post $post The WP_Post object.
+ */
+ return apply_filters( 'comment_reply_link', $before . $link . $after, $args, $comment, $post );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -1068,7 +1098,7 @@
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> * @see get_comment_reply_link() Echoes result
</span><span class="cx"> *
</span><del>- * @param array $args Optional. Override default options.
</del><ins>+ * @param array $args Optional. Override default options, @see get_comment_reply_link().
</ins><span class="cx"> * @param int $comment Optional. Comment being replied to.
</span><span class="cx"> * @param int $post Optional. Post that the comment is going to be displayed on.
</span><span class="cx"> * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
</span><span class="lines">@@ -1087,6 +1117,8 @@
</span><span class="cx"> * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
</span><span class="cx"> * parameters.
</span><span class="cx"> *
</span><ins>+ * @todo See get_comment_reply_link() for a template of the args docblock.
+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><span class="cx"> * @param array $args Optional. Override default options.
</span><span class="lines">@@ -1116,10 +1148,10 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Displays the HTML content for reply to post link.
</span><ins>+ *
</ins><span class="cx"> * @since 2.7.0
</span><del>- * @see get_post_reply_link()
</del><span class="cx"> *
</span><del>- * @param array $args Optional. Override default options.
</del><ins>+ * @param array $args Optional. Override default options, @see get_post_reply_link().
</ins><span class="cx"> * @param int|object $post Optional. Post that the comment is going to be displayed on.
</span><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></pre>
</div>
</div>
</body>
</html>