Automattic\WooCommerce\Internal\Admin\Emails

EmailListingRestController::validate_email_id │ private │ WC 1.0

Validate the email ID.

Method of the class: EmailListingRestController{}

No Hooks.

Returns

true|false|WP_Error. True if the email ID is valid, otherwise a WP_Error object.

Usage

// private - for code of main (parent) class only
$result = $this->validate_email_id( $email_id );

$email_id(string) (required)

The email ID to validate.

EmailListingRestController::validate_email_id() EmailListingRestController::validate email id code ^{WC 10.3.3}

private function validate_email_id( string $email_id ) {
	if ( ! in_array( $email_id, WCTransactionalEmails::get_transactional_emails(), true ) ) {
		return new \WP_Error(
			'woocommerce_rest_not_allowed_email_id',
			sprintf( 'The provided email ID "%s" is not allowed.', $email_id ),
			array( 'status' => 400 ),
		);
	}
	return true;
}