WP_REST_Comments_Controller::check_comment_author_email( string $value, WP_REST_Request $request, string $param )

Checks a comment author email for validity.

Description

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.

Parameters

$value: (Required) Author email value submitted.
$request: (Required) Full details about the request.
$param: (Required) The parameter name.

Return

(WP_Error|string) The sanitized email address, if valid, otherwise an error.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.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;
	}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/rest-api.php: rest_validate_request_arg()	Validate a request argument based on details registered to the route.
wp-includes/load.php: is_wp_error()	Check whether variable is a ClassicPress Error.

Changelog

Changelog
Version	Description
WP-4.7.0	Introduced.