WordPress at a glance
filter is not described

sanitize_email filter-hook . WP 2.8.0

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.

Usage

add_filter( 'sanitize_email', 'filter_function_name_6941', 10, 3 );
function filter_function_name_6941( $sanitized_email, $email, $message ){
	// filter...

	return $sanitized_email;
}
$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.

Changelog

Since 2.8.0 Introduced.

Where the hook is called

sanitize_email()
sanitize_email
wp-includes/formatting.php 3528
return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );
wp-includes/formatting.php 3534
return apply_filters( 'sanitize_email', '', $email, 'email_no_at' );
wp-includes/formatting.php 3545
return apply_filters( 'sanitize_email', '', $email, 'local_invalid_chars' );
wp-includes/formatting.php 3553
return apply_filters( 'sanitize_email', '', $email, 'domain_period_sequence' );
wp-includes/formatting.php 3560
return apply_filters( 'sanitize_email', '', $email, 'domain_period_limits' );
wp-includes/formatting.php 3569
return apply_filters( 'sanitize_email', '', $email, 'domain_no_periods' );
wp-includes/formatting.php 3592
return apply_filters( 'sanitize_email', '', $email, 'domain_no_valid_subs' );
wp-includes/formatting.php 3603
return apply_filters( 'sanitize_email', $sanitized_email, $email, null );

Where the hook is used (in WP core)

Usage not found!