WordPress at a glance
function is not described

WP_REST_Comments_Controller::check_comment_author_email() public WP 4.7.0

Checks a comment author email for validity.

Accepts either a valid email address or empty string as a valid comment author email address. Setting the comment author email to an empty string is allowed when a comment is being updated.

{} It's a method of the class: WP_REST_Comments_Controller{}

No Hooks.

Return

String/WP_Error. The sanitized email address, if valid, otherwise an error.

Usage

$WP_REST_Comments_Controller = new WP_REST_Comments_Controller();
$WP_REST_Comments_Controller->check_comment_author_email( $value, $request, $param );
$value(string) (required)
Author email value submitted.
$request(WP_REST_Request) (required)
Full details about the request.
$param(string) (required)
The parameter name.

Changelog

Since 4.7.0 Introduced.

Code of WP_REST_Comments_Controller::check_comment_author_email() WP 5.5.1

<?php
public function check_comment_author_email( $value, $request, $param ) {
	$email = (string) $value;
	if ( empty( $email ) ) {
		return $email;
	}

	$check_email = rest_validate_request_arg( $email, $request, $param );
	if ( is_wp_error( $check_email ) ) {
		return $check_email;
	}

	return $email;
}