wppaste
WordPress

get_edit_comment_link( int|WP_Comment $comment_id = 0, string $context = 'display' ): string|void

Since
2.3.0, 6.7.0
Source
wp-includes/link-template.php:1606
Retrieves the edit comment link.

Parameters

$comment_idint|WP_Commentoptional
Comment ID or WP_Comment object.Default: 0
$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.

Hooks fired · 1

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

  1. apply_filters( get_edit_comment_link )filterline 1634 (+28 into the body)

    Filters the comment edit link.

Uses · 4

  • get_comment()Retrieves comment data given a comment ID or comment object.
  • current_user_can()Returns whether the current user has the specified capability.
  • admin_url()Retrieves the URL to the admin area for the current site.
  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

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 );}

History

Introduced in 2.3.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.

7.0.4
Return type changed from string|void to string|null.verified against source
6.7.0
The $context parameter was added.from the docblock
2.3.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/link-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.