W3cubDocs

/WordPress

apply_filters( 'sanitize_email', string $sanitized_email, string $email, string|null $message )

Filters a sanitized email address.

Description

This filter is evaluated under several contexts, including ’email_too_short’, ’email_no_at’, ‘local_invalid_chars’, ‘domain_period_sequence’, ‘domain_period_limits’, ‘domain_no_periods’, ‘domain_no_valid_subs’, or no context.

Parameters

$sanitized_email

(string) The sanitized email address.

$email

(string) The email address, as provided to sanitize_email().

$message

(string|null) A message to pass to the user. null if email is sanitized.

Source

File: wp-includes/formatting.php

View on Trac

Used By

Used By Description
wp-includes/formatting.php: sanitize_email()

Strips out all characters that are not allowable in an email.

Changelog

Version Description
2.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/sanitize_email