Filter hook 'sanitize_email'
in WP Core File wp-includes/formatting.php at line 3773
Description
Filters a sanitized email address. 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.
Occurrences
| Filename |
Line Number |
| wp-includes/formatting.php |
3773 |
| wp-includes/formatting.php |
3779 |
| wp-includes/formatting.php |
3792 |
| wp-includes/formatting.php |
3802 |
| wp-includes/formatting.php |
3809 |
| wp-includes/formatting.php |
3818 |
| wp-includes/formatting.php |
3841 |
| wp-includes/formatting.php |
3852 |
Parameters
| Type |
Name |
Description |
| string |
$sanitized_email |
The sanitized email address. |
| string |
$email |
The email address, as provided to sanitize_email(). |
| string|null |
$message |
A message to pass to the user. null if email is sanitized. |
PHP Doc
/**
* Filters a sanitized email address.
*
* 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.
*
* @since 2.8.0
*
* @param string $sanitized_email The sanitized email address.
* @param string $email The email address, as provided to sanitize_email().
* @param string|null $message A message to pass to the user. null if email is sanitized.
*/