edit_comment_link( string $text = null, string $before = '', string $after = '' )
- Since
- 1.0.0
- Source
wp-includes/link-template.php:1646
Compatibility
- WordPress
- since 1.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$textstringoptional- Anchor text. If null, default is 'Edit This'. Default null.Default:
null $beforestringoptional- Display before edit link. Default empty.Default:
'' $afterstringoptional- Display after edit link. Default empty.Default:
''
Performance profile
How much work a call to 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
- Scaling
- Constant
- Instructions
- 14–41
- Plugin surface
- 1 hook
- Called by
- 7
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 42.
Third-party callbacks on 'edit_comment_link' run inside this call, and their cost is not bounded by anything here.
7 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_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 edit_comment_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!current_user_can() | 14 | get_comment(), current_user_can() |
current_user_can() && $text !== null | 37 | get_comment(), current_user_can(), get_edit_comment_link(), esc_url(), apply_filters() |
current_user_can() && $text === null | 41 | get_comment(), current_user_can(), __(), get_edit_comment_link(), esc_url(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 42 instructions, 14–41 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while edit_comment_link() runs, in this order:
- apply_filters( edit_comment_link )filterline 1668 (+22 into the body)
Filters the comment edit link anchor tag.
Uses · 6
- get_comment()Retrieves comment data given a comment ID or comment object.
- current_user_can()Returns whether the current user has the specified capability.
- __()Retrieves the translation of $text.
- esc_url()Checks and cleans a URL.
- get_edit_comment_link()Retrieves the edit comment link.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 7
- TwentyNineteen_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- Walker_Comment::comment()Outputs a single comment.
- Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- Walker_Comment::ping()Outputs a pingback comment.
- twentyeleven_comment()Template for comments and pingbacks.
- twentyten_comment()Template for comments and pingbacks.
- twentytwelve_comment()Template for comments and pingbacks.
Source code
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 string $comment_id Comment ID as a numeric string. * @param string $text Anchor text. */ echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after;}Changelog
Introduced in 1.0.0. Unchanged from 6.7.7 through 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/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.