get_cancel_comment_reply_link( string $link_text = '', int|WP_Post|null $post = null ): string
- Since
- 2.7.0, 6.2.0
- Source
wp-includes/comment-template.php:1994
Compatibility
- WordPress
- since 6.2.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
$link_textstringoptional- Text to display for cancel reply link. If empty, defaults to 'Click here to cancel reply'. Default empty.Default:
'' $postint|WP_Post|nulloptional- The post the comment thread is being displayed for. Defaults to the current global post.Default:
null
Return value
string
Performance profile
How much work a call to get_cancel_comment_reply_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
- 36–47
- Plugin surface
- 1 hook
- Called by
- 1
Reaches the database via get_post().
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 49.
Third-party callbacks on 'cancel_comment_reply_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_post()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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_cancel_comment_reply_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($link_text) | 36–37 | get_post(), remove_query_arg(), esc_url(), sprintf(), apply_filters() |
empty($link_text) | 40–41 | __(), get_post(), remove_query_arg(), esc_url(), sprintf(), apply_filters() |
!empty($link_text) | 42–43 | get_post(), _get_comment_reply_id(), remove_query_arg(), esc_url(), sprintf(), apply_filters() |
empty($link_text) | 46–47 | __(), get_post(), _get_comment_reply_id(), remove_query_arg(), esc_url(), sprintf(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 48 | 36–46 | 3 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 49 | 36–47 | 3 | |
| 8.4 | 49 | 36–47 | 3 | |
| 8.3 | 49 | 36–47 | 3 | |
| 8.2 | 49 | 36–47 | 3 | |
| 8.1 | 49 | 36–47 | 3 | |
| 7.4 | 49 | 36–47 | 3 |
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 get_cancel_comment_reply_link() runs, in this order:
- apply_filters( cancel_comment_reply_link )filterline 2020 (+26 into the body)
Filters the cancel comment reply link HTML.
Uses · 6
- __()Retrieves the translation of $text.
- get_post()Retrieves post data given a post ID or post object.
- _get_comment_reply_id()Gets the comment's reply to ID from the $_GET['replytocom'].
- esc_url()Checks and cleans a URL.
- remove_query_arg()Removes an item or items from a query string.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- cancel_comment_reply_link()Displays HTML content for cancel comment reply link.
Source code
function get_cancel_comment_reply_link( $link_text = '', $post = null ) { if ( empty( $link_text ) ) { $link_text = __( 'Click here to cancel reply.' ); } $post = get_post( $post ); $reply_to_id = $post ? _get_comment_reply_id( $post->ID ) : 0; $link_style = 0 !== $reply_to_id ? '' : ' style="display:none;"'; $link_url = esc_url( remove_query_arg( array( 'replytocom', 'unapproved', 'moderation-hash' ) ) ) . '#respond'; $cancel_comment_reply_link = sprintf( '<a rel="nofollow" id="cancel-comment-reply-link" href="%1$s"%2$s>%3$s</a>', $link_url, $link_style, $link_text ); /** * Filters the cancel comment reply link HTML. * * @since 2.7.0 * * @param string $cancel_comment_reply_link The HTML-formatted cancel comment reply link. * @param string $link_url Cancel comment reply link URL. * @param string $link_text Cancel comment reply link text. */ return apply_filters( 'cancel_comment_reply_link', $cancel_comment_reply_link, $link_url, $link_text );}Changelog
Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/comment-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.