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

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

string|false|null

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

Hooks fired · 2

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

1. 1
   apply_filters( comment_reply_link_args )filterline 1811 (+56 into the body)

   Filters the comment reply link arguments.

2. 2
   apply_filters( comment_reply_link )filterline 1872 (+117 into the body)

   Filters the comment reply link.

Uses · 15

• __()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.
• wp_login_url()Retrieves the login 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

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

History

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