get_comment_reply_link( array $args = array(), int|WP_Comment $comment = null, int|WP_Post $post = null )
Retrieve HTML content for reply to comment link.
Parameters
- $args
-
(Optional) Override default arguments.
- 'add_below'
(string) 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'. - 'respond_id'
(string) 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'. - 'reply_text'
(string) The text of the Reply link. Default 'Reply'. - 'login_text'
(string) The text of the link to reply if logged out. Default 'Log in to Reply'. - 'max_depth'
(int) The max depth of the comment tree. Default 0. - 'depth'
(int) 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. - 'before'
(string) The text or HTML to add before the reply link. - 'after'
(string) The text or HTML to add after the reply link.
Default value: array()
- 'add_below'
- $comment
-
(Optional) Comment being replied to. Default current comment.
Default value: null
- $post
-
(Optional) Post ID or WP_Post object the comment is going to be displayed on. Default current post.
Default value: null
Return
(void|false|string) Link to show comment form, if successful. False, if comments are closed.
Source
File: wp-includes/comment-template.php
function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
$defaults = array(
'add_below' => 'comment',
'respond_id' => 'respond',
'reply_text' => __( 'Reply' ),
/* translators: Comment reply button text. 1: Comment author name */
'reply_to_text' => __( 'Reply to %s' ),
'login_text' => __( 'Log in to Reply' ),
'max_depth' => 0,
'depth' => 0,
'before' => '',
'after' => ''
);
$args = wp_parse_args( $args, $defaults );
if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] ) {
return;
}
$comment = get_comment( $comment );
if ( empty( $post ) ) {
$post = $comment->comment_post_ID;
}
$post = get_post( $post );
if ( ! comments_open( $post->ID ) ) {
return false;
}
/**
* Filters the comment reply link arguments.
*
* @since WP-4.1.0
*
* @param array $args Comment reply link arguments. See get_comment_reply_link()
* for more information on accepted arguments.
* @param WP_Comment $comment The object of the comment being replied to.
* @param WP_Post $post The WP_Post object.
*/
$args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {
$link = sprintf( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',
esc_url( wp_login_url( get_permalink() ) ),
$args['login_text']
);
} else {
$onclick = sprintf( 'return addComment.moveForm( "%1$s-%2$s", "%2$s", "%3$s", "%4$s" )',
$args['add_below'], $comment->comment_ID, $args['respond_id'], $post->ID
);
$link = sprintf( "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s' aria-label='%s'>%s</a>",
esc_url( add_query_arg( 'replytocom', $comment->comment_ID, get_permalink( $post->ID ) ) ) . "#" . $args['respond_id'],
$onclick,
esc_attr( sprintf( $args['reply_to_text'], $comment->comment_author ) ),
$args['reply_text']
);
}
/**
* Filters the comment reply link.
*
* @since WP-2.7.0
*
* @param string $link The HTML markup for the comment 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', $args['before'] . $link . $args['after'], $args, $comment, $post );
}
Changelog
| Version | Description |
|---|---|
| WP-4.4.0 | Added the ability for $comment to also accept a WP_Comment object. |
| WP-2.7.0 | Introduced. |