W3cubDocs

/WordPress

edit_comment_link( string $text = null, string $before = '', string $after = '' )

Displays the edit comment link with formatting.

Description

Parameters

$text

(string) (Optional) Anchor text. If null, default is 'Edit This'.

Default value: null

$before

(string) (Optional) Display before edit link.

Default value: ''

$after

(string) (Optional) Display after edit link.

Default value: ''

Source

File: wp-includes/link-template.php

function edit_comment_link( $text = null, $before = '', $after = '' ) {
	$comment = get_comment();

	if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) {
		return;
	}

	if ( null === $text ) {
		$text = __( 'Edit This' );
	}

	$link = '<a class="comment-edit-link" href="' . esc_url( get_edit_comment_link( $comment ) ) . '">' . $text . '</a>';

	/**
	 * Filters the comment edit link anchor tag.
	 *
	 * @since 2.3.0
	 *
	 * @param string $link       Anchor tag for the edit link.
	 * @param int    $comment_id Comment ID.
	 * @param string $text       Anchor text.
	 */
	echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after;
}

Changelog

Version Description
1.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/edit_comment_link