On this page
get_comment_author_email_link( string $linktext = '', string $before = '', string $after = '', int|WP_Comment $comment = null ): string
Returns 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.
Parameters
$linktextstring Optional-
Text to display instead of the comment author's email address.
Default:
'' $beforestring Optional-
Text or HTML to display before the email link.
Default:
'' $afterstring Optional-
Text or HTML to display after the email link.
Default:
'' $commentint|WP_Comment Optional-
Comment ID or WP_Comment object. Default is the current comment.
Default:
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. View all references
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 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.
*/
$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 '';
}
}
Hooks
- apply_filters( 'comment_email',
string $comment_author_email ,WP_Comment $comment ) -
Filters the comment author’s email for display.
Related
Uses
| Uses | Description |
|---|---|
| esc_url() wp-includes/formatting.php | Checks and cleans a URL. |
| esc_html() wp-includes/formatting.php | Escaping for HTML blocks. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
| get_comment() wp-includes/comment.php | Retrieves comment data given a comment ID or comment object. |
Used By
| Used By | Description |
|---|---|
| comment_author_email_link() wp-includes/comment-template.php | Displays the HTML email link to the author of the current comment. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comment_author_email_link