get_comment_reply_link( array $args = array(), int|WP_Comment $comment = null, int|WP_Post $post = null ): string|false|null

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: 'comment'

  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: 'Reply'

  The visible text of the Reply link.

• $reply_to_textstringdefault: 'Reply to %s'. Should start with the visible reply_text value

  The accessible name of the Reply link, using %s as a placeholder for the comment author's name.

• $show_reply_to_textbooldefault: false

  Whether to use reply_to_text as visible link text.

• $login_textstringdefault: 'Log in to Reply'

  The text of the link to reply if logged out.

• $max_depthintdefault: 0

  The max depth of the comment tree.

• $depthintdefault: 0

  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.

• $beforestringdefault: empty

  The text or HTML to add before the reply link.

• $afterstringdefault: empty

  The text or HTML to add after the reply link.

$commentint|WP_Commentoptional

Comment being replied to. Default current comment.Default: null

$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|null

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

Performance profile

How much work a call to get_comment_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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

41–183

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

Plugin surface

2 hooks

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

Called by

3

3 places 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_comment_reply_link()
• serializeserialisationmaybe_unserialize()one call below get_comment_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 · 29 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while get_comment_reply_link() runs, in this order:

1. 1
   apply_filters( comment_reply_link_args )filterline 1812 (+57 into the body)

   Filters the comment reply link arguments.

2. 2
   apply_filters( comment_reply_link )filterline 1873 (+118 into the body)

   Filters the comment reply link.

Uses · 16

• _x()Retrieves translated string with gettext context.
• __()Retrieves the translation of $text.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_comment()Retrieves comment data given a comment ID or comment object.
• 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.
• get_comment_link()Retrieves the link to a given comment.
• 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.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• esc_url()Checks and cleans a URL.

Used by · 3

• TwentyTwenty_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
• comment_reply_link()Displays the HTML content for reply to comment link.
• render_block_core_comment_reply_link()Renders the `core/comment-reply-link` block on the server.

Source code

View on Trac ↗View on GitHub ↗

1755function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {1756	$defaults = array(1757		'add_below'          => 'comment',1758		'respond_id'         => 'respond',1759		/* translators: Comment reply button text. */1760		'reply_text'         => _x( 'Reply', 'verb' ),1761		/* translators: Comment reply button text. %s: Comment author name. */1762		'reply_to_text'      => __( 'Reply to %s' ),1763		'login_text'         => __( 'Log in to Reply' ),1764		'max_depth'          => 0,1765		'depth'              => 0,1766		'before'             => '',1767		'after'              => '',1768		'show_reply_to_text' => false,1769	);1770 1771	$args = wp_parse_args( $args, $defaults );1772 1773	$args['max_depth'] = (int) $args['max_depth'];1774	$args['depth']     = (int) $args['depth'];1775 1776	if ( 0 === $args['depth'] || $args['max_depth'] <= $args['depth'] ) {1777		return null;1778	}1779 1780	$comment = get_comment( $comment );1781 1782	if ( empty( $comment ) ) {1783		return null;1784	}1785 1786	if ( empty( $post ) ) {1787		$post = $comment->comment_post_ID;1788	}1789 1790	$post = get_post( $post );1791 1792	if ( ! comments_open( $post->ID ) ) {1793		return false;1794	}1795 1796	if ( get_option( 'page_comments' ) ) {1797		$permalink = str_replace( '#comment-' . $comment->comment_ID, '', get_comment_link( $comment ) );1798	} else {1799		$permalink = get_permalink( $post->ID );1800	}1801 1802	/**1803	 * Filters the comment reply link arguments.1804	 *1805	 * @since 4.1.01806	 *1807	 * @param array      $args    Comment reply link arguments. See get_comment_reply_link()1808	 *                            for more information on accepted arguments.1809	 * @param WP_Comment $comment The object of the comment being replied to.1810	 * @param WP_Post    $post    The WP_Post object.1811	 */1812	$args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );1813 1814	if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {1815		$link = sprintf(1816			'<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',1817			esc_url( wp_login_url( get_permalink() ) ),1818			$args['login_text']1819		);1820	} else {1821		$data_attributes = array(1822			'commentid'      => $comment->comment_ID,1823			'postid'         => $post->ID,1824			'belowelement'   => $args['add_below'] . '-' . $comment->comment_ID,1825			'respondelement' => $args['respond_id'],1826			'replyto'        => sprintf( $args['reply_to_text'], get_comment_author( $comment ) ),1827		);1828 1829		$data_attribute_string = '';1830 1831		foreach ( $data_attributes as $name => $value ) {1832			$data_attribute_string .= " data-{$name}=\"" . esc_attr( $value ) . '"';1833		}1834

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 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.