comment_author_email() WordPress Function

The comment_author_email() function is used to display the email address of the author of the current comment. This function can be used within the comments template to display the author's email address.

comment_author_email( int|WP_Comment $comment_ID ) #

Displays the email of the author of the current global $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

$comment_ID

(int|WP_Comment)(Optional) WP_Comment or the ID of the comment for which to print the author's email. Default current comment.


Top ↑

Source

File: wp-includes/comment-template.php

function comment_author_email( $comment_ID = 0 ) {
	$comment      = get_comment( $comment_ID );
	$author_email = get_comment_author_email( $comment );

	/**
	 * Filters the comment author's email for display.
	 *
	 * @since 1.2.0
	 * @since 4.1.0 The `$comment_ID` parameter was added.
	 *
	 * @param string $author_email The comment author's email address.
	 * @param string $comment_ID   The comment ID as a numeric string.
	 */
	echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
}


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Added the ability for $comment_ID to also accept a WP_Comment object.
0.71Introduced.

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