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

Description

Parameters

$valuestring

Author email value submitted.

$requestWP_REST_Request

Full details about the request.

$paramstring

The parameter name.

Return

string|WP_Error

The sanitized email address, if valid, otherwise an error.

Uses · 2

• rest_validate_request_arg()Validate a request argument based on details registered to the route.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Source

View on Trac ↗View on GitHub ↗

1883	public function check_comment_author_email( $value, $request, $param ) {1884		$email = (string) $value;1885		if ( empty( $email ) ) {1886			return $email;1887		}1888 1889		$check_email = rest_validate_request_arg( $email, $request, $param );1890		if ( is_wp_error( $check_email ) ) {1891			return $check_email;1892		}1893 1894		return $email;1895	}

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.