get_edit_comment_link( int|WP_Comment $comment_id = 0, string $context = 'display' ): string|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

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

string|null

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

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9–34

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

Plugin surface

1 hook

Third-party callbacks on 'get_edit_comment_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

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( get_edit_comment_link )filterline 1633 (+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

• TwentyTwenty_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
• edit_comment_link()Displays the edit comment link with formatting.
• render_block_core_comment_edit_link()Renders the `core/comment-edit-link` block on the server.

Source code

View on Trac ↗View on GitHub ↗

1605function get_edit_comment_link( $comment_id = 0, $context = 'display' ) {1606	$comment = get_comment( $comment_id );1607 1608	if ( ! is_object( $comment ) || ! current_user_can( 'edit_comment', $comment->comment_ID ) ) {1609		return null;1610	}1611 1612	if ( 'display' === $context ) {1613		$action = 'comment.php?action=editcomment&c=';1614	} else {1615		$action = 'comment.php?action=editcomment&c=';1616	}1617 1618	$location = admin_url( $action ) . $comment->comment_ID;1619 1620	// Ensure the $comment_id variable passed to the filter is always an ID.1621	$comment_id = (int) $comment->comment_ID;1622 1623	/**1624	 * Filters the comment edit link.1625	 *1626	 * @since 2.3.01627	 * @since 6.7.0 The `$comment_id` and `$context` parameters are now being passed to the filter.1628	 *1629	 * @param string $location   The edit link.1630	 * @param int    $comment_id Unique ID of the comment to generate an edit link.1631	 * @param string $context    Context to include HTML entities in link. Default 'display'.1632	 */1633	return apply_filters( 'get_edit_comment_link', $location, $comment_id, $context );1634}

Changelog

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.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.