get_comment_author_email_link( string $link_text = '', string $before = '', string $after = '', int|WP_Comment $comment = null ): string
- Since
- 2.7.0, 4.6.0
- Source
wp-includes/comment-template.php:188
Description
Care should be taken to protect the email address and assure that email harvesters do not capture your commenter's email address. Most assume that their email address will not appear in raw form on the site. Doing so will enable anyone, including those that people don't want to get the email address and use it for their own means good and bad.
Compatibility
- WordPress
- since 4.6.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 instead of the comment author's email address.
Default empty.Default:'' $beforestringoptional- Text or HTML to display before the email link. Default empty.Default:
'' $afterstringoptional- Text or HTML to display after the email link. Default empty.Default:
'' $commentint|WP_Commentoptional- Comment ID or WP_Comment object. Default is the current comment.Default:
null
Return value
string- HTML markup for the comment author email link. By default, the email address is obfuscated via the 'comment_email' filter with antispambot().
Performance profile
How much work a call to get_comment_author_email_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
- 19–40
- Plugin surface
- 1 hook
- Called by
- 1
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 'comment_email' 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
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize, query 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_author_email_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 19–21 | get_comment(), apply_filters() |
!empty($comment_author_email) && $comment_author_email !== "@" | 39–40 | get_comment(), apply_filters(), esc_url(), esc_html(), sprintf() |
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, 19–40 executed per call, 3 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 get_comment_author_email_link() runs, in this order:
- apply_filters( comment_email )filterline 203 (+15 into the body)
Filters the comment author's email for display.
Uses · 4
- get_comment()Retrieves comment data given a comment ID or comment object.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- esc_url()Checks and cleans a URL.
- esc_html()Escaping for HTML blocks.
Used by · 1
- comment_author_email_link()Displays the HTML email link to the author of the current comment.
Source code
function get_comment_author_email_link( $link_text = '', $before = '', $after = '', $comment = null ) { $comment = get_comment( $comment ); /** * Filters the comment author's email for display. * * Care should be taken to protect the email address and assure that email * harvesters do not capture your commenter's email address. * * @since 1.2.0 * @since 4.1.0 The `$comment` parameter was added. * * @param string $comment_author_email The comment author's email address. * @param WP_Comment $comment The comment object. */ $comment_author_email = apply_filters( 'comment_email', $comment->comment_author_email, $comment ); if ( ( ! empty( $comment_author_email ) ) && ( '@' !== $comment_author_email ) ) { $display = ( '' !== $link_text ) ? $link_text : $comment_author_email; $comment_author_email_link = $before . sprintf( '<a href="%1$s">%2$s</a>', esc_url( 'mailto:' . $comment_author_email ), esc_html( $display ) ) . $after; return $comment_author_email_link; } else { return ''; }}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.
$comment parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.