edit_term_link( string $link = '', string $before = '', string $after = '', int|WP_Term|null $term = null, bool $display = true ): string|void
- Since
- 3.1.0
- Source
wp-includes/link-template.php:1136
Compatibility
- WordPress
- since 3.1.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
$linkstringoptional- Anchor text. If empty, default is 'Edit This'. Default empty.Default:
'' $beforestringoptional- Display before edit link. Default empty.Default:
'' $afterstringoptional- Display after edit link. Default empty.Default:
'' $termint|WP_Term|nulloptional- Term ID or object. If null, the queried object will be inspected. Default null.Default:
null $displaybooloptional- Whether or not to echo the return. Default true.Default:
true
Return value
string|void- HTML content.
Performance profile
How much work a call to edit_term_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
- Heavy
- Scaling
- Constant
- Instructions
- 13–57
- Plugin surface
- 1 hook
- Called by
- 1
Reaches the database via get_term().
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 64.
Third-party callbacks on 'edit_term_link' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_term()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach 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 · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost edit_term_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$term !== null | 13 | get_term() |
$term === null | 13 | get_queried_object() |
$term !== null && !current_user_can() | 26 | get_term(), get_taxonomy(), current_user_can() |
$term === null && !current_user_can() | 26 | get_queried_object(), get_taxonomy(), current_user_can() |
$term !== null && current_user_can() && !empty($link) | 52–53 | get_term(), get_taxonomy(), current_user_can(), get_edit_term_link(), apply_filters() |
$term === null && current_user_can() && !empty($link) | 52–53 | get_queried_object(), get_taxonomy(), current_user_can(), get_edit_term_link(), apply_filters() |
$term !== null && current_user_can() && empty($link) | 56–57 | get_term(), get_taxonomy(), current_user_can(), __(), get_edit_term_link(), apply_filters() |
$term === null && current_user_can() && empty($link) | 56–57 | get_queried_object(), get_taxonomy(), current_user_can(), __(), get_edit_term_link(), 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: 64 instructions, 13–57 executed per call, 5 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_term_link() runs, in this order:
- apply_filters( edit_term_link )filterline 1166 (+30 into the body)
Filters the anchor tag for the edit link of a term.
Uses · 7
- get_queried_object()Retrieves the currently queried object.
- get_term()Gets all term data from database by term ID.
- get_taxonomy()Retrieves the taxonomy object of $taxonomy.
- current_user_can()Returns whether the current user has the specified capability.
- __()Retrieves the translation of $text.
- get_edit_term_link()Retrieves the URL for editing a given term.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- edit_tag_link()Displays or retrieves the edit link for a tag with formatting.
Source code
function edit_term_link( $link = '', $before = '', $after = '', $term = null, $display = true ) { if ( is_null( $term ) ) { $term = get_queried_object(); } else { $term = get_term( $term ); } if ( ! $term ) { return; } $tax = get_taxonomy( $term->taxonomy ); if ( ! current_user_can( 'edit_term', $term->term_id ) ) { return; } if ( empty( $link ) ) { $link = __( 'Edit This' ); } $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>'; /** * Filters the anchor tag for the edit link of a term. * * @since 3.1.0 * * @param string $link The anchor tag for the edit link. * @param int $term_id Term ID. */ $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after; if ( $display ) { echo $link; } else { return $link; }}Changelog
Introduced in 3.1.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
string|void to string|null.verified against sourceAbout 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.