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

Parameters

$argsarrayoptional

Override default arguments.Default: array()

• $add_belowstringdefault: is 'post'

  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.

• $respond_idstringdefault: 'respond'

  The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(), and appended to the link URL as a hash value.

• $reply_textstringdefault: is 'Leave a Comment'

  Text of the Reply link.

• $login_textstringdefault: is 'Log in to leave a Comment'

  Text of the link to reply if logged out.

• $beforestringdefault: empty

  Text or HTML to add before the reply link.

• $afterstringdefault: empty

  Text or HTML to add after the reply link.

$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

Link to show comment form on success. False if comments are closed.

Hooks fired · 1

One hook fires while get_post_reply_link() runs, in this order:

1. 1
   apply_filters( post_comments_link )filterline 1964 (+50 into the body)

   Filters the formatted post comments link HTML.

Uses · 9

• __()Retrieves the translation of $text.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_post()Retrieves post data given a post ID or post object.
• comments_open()Determines whether the current post is open for comments.
• get_option()Retrieves an option value based on an option name.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• wp_login_url()Retrieves the login URL.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• post_reply_link()Displays the HTML content for reply to post link.

Source

View on Trac ↗View on GitHub ↗

1914function get_post_reply_link( $args = array(), $post = null ) {1915	$defaults = array(1916		'add_below'  => 'post',1917		'respond_id' => 'respond',1918		'reply_text' => __( 'Leave a Comment' ),1919		'login_text' => __( 'Log in to leave a Comment' ),1920		'before'     => '',1921		'after'      => '',1922	);1923 1924	$args = wp_parse_args( $args, $defaults );1925 1926	$post = get_post( $post );1927 1928	if ( ! comments_open( $post->ID ) ) {1929		return false;1930	}1931 1932	if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {1933		$link = sprintf(1934			'<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',1935			wp_login_url( get_permalink() ),1936			$args['login_text']1937		);1938	} else {1939		$onclick = sprintf(1940			'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )',1941			$args['add_below'],1942			$post->ID,1943			$args['respond_id']1944		);1945 1946		$link = sprintf(1947			"<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s'>%s</a>",1948			get_permalink( $post->ID ) . '#' . $args['respond_id'],1949			$onclick,1950			$args['reply_text']1951		);1952	}1953 1954	$post_reply_link = $args['before'] . $link . $args['after'];1955 1956	/**1957	 * Filters the formatted post comments link HTML.1958	 *1959	 * @since 2.7.01960	 *1961	 * @param string      $post_reply_link The HTML-formatted post comments link.1962	 * @param int|WP_Post $post            The post ID or WP_Post object.1963	 */1964	return apply_filters( 'post_comments_link', $post_reply_link, $post );1965}

History

Introduced in 2.7.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/comment-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.