email_exists() WordPress Function
The email_exists() function is used to check if a given email address exists as a user in the WordPress database. This is useful for making sure that a user exists before attempting to reset their password, for example. The function returns the user ID if the email exists, or false if it does not.
email_exists( string $email ) #
Determines whether the given email exists.
Description
For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.
Parameters
(string)(Required)The email to check for existence.
Return
(int|false) The user ID on success, false on failure.
More Information
This function will check whether or not a given email address ($email) has already been registered to a username, and returns that users ID (or false if none exists). See also username_exists.
This function is normally used when a user is registering, to ensure that the E-mail address the user is attempting to register with has not already been registered.
Source
File: wp-includes/user.php
function email_exists( $email ) { $user = get_user_by( 'email', $email ); if ( $user ) { $user_id = $user->ID; } else { $user_id = false; } /** * Filters whether the given email exists. * * @since 5.6.0 * * @param int|false $user_id The user ID associated with the email, * or false if the email does not exist. * @param string $email The email to check for existence. */ return apply_filters( 'email_exists', $user_id, $email ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.1.0 | Introduced. |