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', 'wp_kama_sanitize_email_filter', 10, 3 );

/**
 * Function for `sanitize_email` filter-hook.
 * 
 * @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.
 *
 * @return string
 */
function wp_kama_sanitize_email_filter( $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

Where the hook is called

return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );

return apply_filters( 'sanitize_email', '', $email, 'email_no_at' );

return apply_filters( 'sanitize_email', '', $email, 'local_invalid_chars' );

return apply_filters( 'sanitize_email', '', $email, 'domain_period_sequence' );

return apply_filters( 'sanitize_email', '', $email, 'domain_period_limits' );

return apply_filters( 'sanitize_email', '', $email, 'domain_no_periods' );

return apply_filters( 'sanitize_email', '', $email, 'domain_no_valid_subs' );

return apply_filters( 'sanitize_email', $sanitized_email, $email, null );

Where the hook is used in WordPress