get_edit_comment_link( int|WP_Comment $comment_id, string $context = ‘display’ ): string|void

In this article

Retrieves the edit comment link.

Parameters

$comment_idint|WP_Commentoptional
Comment ID or WP_Comment object.
$contextstringoptional
Context in which the URL should be used. Either 'display', to include HTML entities, or 'url'. Default 'display'.

Default:'display'

Return

string|void The edit comment link URL for the given comment, or void if the comment id does not exist or the current user is not allowed to edit it.

Source

function get_edit_comment_link( $comment_id = 0, $context = 'display' ) {
	$comment = get_comment( $comment_id );

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

	if ( 'display' === $context ) {
		$action = 'comment.php?action=editcomment&c=';
	} else {
		$action = 'comment.php?action=editcomment&c=';
	}

	$location = admin_url( $action ) . $comment->comment_ID;

	// Ensure the $comment_id variable passed to the filter is always an ID.
	$comment_id = (int) $comment->comment_ID;

	/**
	 * Filters the comment edit link.
	 *
	 * @since 2.3.0
	 * @since 6.7.0 The $comment_id and $context parameters are now being passed to the filter.
	 *
	 * @param string $location   The edit link.
	 * @param int    $comment_id Unique ID of the comment to generate an edit link.
	 * @param string $context    Context to include HTML entities in link. Default 'display'.
	 */
	return apply_filters( 'get_edit_comment_link', $location, $comment_id, $context );
}

Hooks

apply_filters( ‘get_edit_comment_link’, string $location, int $comment_id, string $context )

Filters the comment edit link.

Changelog

VersionDescription
6.7.0The $context parameter was added.
2.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.