wppaste
WordPress

comment_author_email_link( string $link_text = '', string $before = '', string $after = '', int|WP_Comment $comment = null )

Since
0.71, 4.6.0
Source
wp-includes/comment-template.php:161
Displays the HTML email link to the author of the current comment.

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

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
13–14

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()one call below comment_author_email_link()

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always13–14get_comment_author_email_link()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 14 instructions, 13–14 executed per call, 1 branch. 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.

Uses · 1

Source code

View on Trac View on GitHub 

function comment_author_email_link( $link_text = '', $before = '', $after = '', $comment = null ) {	$link = get_comment_author_email_link( $link_text, $before, $after, $comment );	if ( $link ) {		echo $link;	}}

Changelog

Introduced in 0.71. Unchanged from 6.7.7 through 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.

4.6.0
Added the $comment parameter.from the docblock
0.71
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 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.