get_post_reply_link( array $args = array(), int|WP_Post $post = null )
Retrieves HTML content for reply to post link.
Parameters
- $args
-
(Optional) Override default arguments.<br>
- 'add_below'
(string) The first part of the selector used to identify the comment to respond below.<br> The resulting value is passed as the first parameter to addComment.moveForm(), concatenated as $add_below-$comment->comment_ID. Default is 'post'.<br> - '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.<br> Default 'respond'.<br> - 'reply_text'
(string) Text of the Reply link. Default is 'Leave a Comment'.<br> - 'login_text'
(string) Text of the link to reply if logged out. Default is 'Log in to leave a Comment'.<br> - 'before'
(string) Text or HTML to add before the reply link. <br> - 'after'
(string) Text or HTML to add after the reply link. <br>
Default value: array()
- 'add_below'
- $post
-
(Optional) Post ID or WP_Post object the comment is going to be displayed on.<br> Default current post.
Default value: null
Return
(string|false|null) Link to show comment form, if successful. False, if comments are closed.
Source
File: wp-includes/comment-template.php
function get_post_reply_link($args = array(), $post = null) {
$defaults = array(
'add_below' => 'post',
'respond_id' => 'respond',
'reply_text' => __('Leave a Comment'),
'login_text' => __('Log in to leave a Comment'),
'before' => '',
'after' => '',
);
$args = wp_parse_args($args, $defaults);
$post = get_post($post);
if ( ! comments_open( $post->ID ) ) {
return false;
}
if ( get_option('comment_registration') && ! is_user_logged_in() ) {
$link = sprintf( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',
wp_login_url( get_permalink() ),
$args['login_text']
);
} else {
$onclick = sprintf( 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )',
$args['add_below'], $post->ID, $args['respond_id']
);
$link = sprintf( "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s'>%s</a>",
get_permalink( $post->ID ) . '#' . $args['respond_id'],
$onclick,
$args['reply_text']
);
}
$formatted_link = $args['before'] . $link . $args['after'];
/**
* Filters the formatted post comments link HTML.
*
* @since WP-2.7.0
*
* @param string $formatted The HTML-formatted post comments link.
* @param int|WP_Post $post The post ID or WP_Post object.
*/
return apply_filters( 'post_comments_link', $formatted_link, $post );
}
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |