On this page
get_comment_author_email( int|WP_Comment $comment_ID ): string
Retrieves the email of the author of the current comment.
Parameters
$comment_IDint|WP_Comment Optional-
WP_Comment or the ID of the comment for which to get the author's email.
Default current comment.
Return
string The current comment author's email
Source
File: wp-includes/comment-template.php. View all references
function get_comment_author_email( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
/**
* Filters the comment author's returned email address.
*
* @since 1.5.0
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $comment_author_email The comment author's email address.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );
}
Hooks
- apply_filters( 'get_comment_author_email',
string $comment_author_email ,string $comment_ID ,WP_Comment $comment ) -
Filters the comment author’s returned email address.
Related
Uses
| Uses | Description |
|---|---|
| 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() wp-includes/comment-template.php | Displays the email of the author of the current global $comment. |
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Added the ability for $comment_ID to also accept a WP_Comment object. |
| 1.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comment_author_email