get_comment_author_email_link( string $linktext = '', string $before = '', string $after = '', int|WP_Comment $comment = null )
Return 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 commentors’ 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.
Parameters
- $linktext
-
(Optional) Text to display instead of the comment author's email address.
Default value: ''
- $before
-
(Optional) Text or HTML to display before the email link.
Default value: ''
- $after
-
(Optional) Text or HTML to display after the email link.
Default value: ''
- $comment
-
(Optional) Comment ID or WP_Comment object. Default is the current comment.
Default value: null
Return
(string) HTML markup for the comment author email link. By default, the email address is obfuscated via the 'comment_email' filter with antispambot().
Source
File: wp-includes/comment-template.php
function get_comment_author_email_link( $linktext = '', $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 WP-1.2.0
* @since WP-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.
*/
$email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
if ((!empty($email)) && ($email != '@')) {
$display = ($linktext != '') ? $linktext : $email;
$return = $before;
$return .= sprintf( '<a href="%1$s">%2$s</a>', esc_url( 'mailto:' . $email ), esc_html( $display ) );
$return .= $after;
return $return;
} else {
return '';
}
}
Changelog
Version | Description |
---|---|
WP-4.6.0 | Added the $comment parameter. |
WP-2.7.0 | Introduced. |