get_comment_author_email_link() WordPress Function

The get_comment_author_email_link() function allows you to display a link to the author's email address for a given comment. This can be useful if you want to allow readers to contact the author directly.

get_comment_author_email_link( string $linktext = '', string $before = '', string $after = '', int|WP_Comment $comment = null ) #

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.


Top ↑

Parameters

$linktext

(string)(Optional) Text to display instead of the comment author's email address.

Default value: ''

$before

(string)(Optional) Text or HTML to display before the email link.

Default value: ''

$after

(string)(Optional) Text or HTML to display after the email link.

Default value: ''

$comment

(int|WP_Comment)(Optional) Comment ID or WP_Comment object. Default is the current comment.

Default value: null


Top ↑

Return

(string) HTML markup for the comment author email link. By default, the email address is obfuscated via the 'comment_email' filter with antispambot().


Top ↑

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 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 '';
	}
}


Top ↑

Changelog

Changelog
VersionDescription
4.6.0Added the $comment parameter.
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More