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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

string|false

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

Performance profile

How much work a call to get_post_reply_link() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

31–73

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 86.

Plugin surface

1 hook

Third-party callbacks on 'post_comments_link' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_post_reply_link()
• serializeserialisationmaybe_unserialize()one call below get_post_reply_link()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_post_reply_link() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( post_comments_link )filterline 1965 (+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 code

View on Trac ↗View on GitHub ↗

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

Changelog

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 7.0.4 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.