WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_post_reply_link()

get_post_reply_link( array $args = array(), int|WP_Post $post = null ): string|false|null

In this article

Back to top

Retrieves HTML content for reply to post link.

Parameters

$argsarrayoptional
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 is 'post'.
  • 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
    Text of the Reply link. Default is ‘Leave a Comment’.
  • login_text string
    Text of the link to reply if logged out. Default is ‘Log in to leave a Comment’.
  • before string
    Text or HTML to add before the reply link.
  • after string
    Text or HTML to add after the reply link.

Default:array()

$postint|WP_Postoptional
Post ID or WP_Post object the comment is going to be displayed on.
Default current post.

Default:null

Return

string|false|null Link to show comment form, if successful. False, if comments are closed.

Source

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']
		);
	}

	$post_reply_link = $args['before'] . $link . $args['after'];

	/**
	 * Filters the formatted post comments link HTML.
	 *
	 * @since 2.7.0
	 *
	 * @param string      $post_reply_link The HTML-formatted post comments link.
	 * @param int|WP_Post $post            The post ID or WP_Post object.
	 */
	return apply_filters( 'post_comments_link', $post_reply_link, $post );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_comments_link’, string $post_reply_link, int|WP_Post $post )

Filters the formatted post comments link HTML.

UsesDescription
comments_open()wp-includes/comment-template.php

Determines whether the current post is open for comments.

wp_login_url()wp-includes/general-template.php

Retrieves the login URL.

__()wp-includes/l10n.php

Retrieves the translation of $text.

is_user_logged_in()wp-includes/pluggable.php

Determines whether the current visitor is a logged in user.

wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.

get_permalink()wp-includes/link-template.php

Retrieves the full permalink for the current post or post ID.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 7 moreShow less
Used byDescription
post_reply_link()wp-includes/comment-template.php

Displays the HTML content for reply to post link.

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.