email_exists() – Function | Developer.WordPress.org

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

$emailstringrequired: 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

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ’email_exists’, int|false $user_id, string $email ): Filters whether the given email exists.

Uses	Description
get_user_by()`wp-includes/pluggable.php`	Retrieves user info by a given field.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Used by	Description
WP_REST_Users_Controller::update_item()`wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php`	Updates a single user.
send_confirmation_on_profile_email()`wp-includes/user.php`	Sends a confirmation request email when a change of user email address is attempted.
edit_user()`wp-admin/includes/user.php`	Edit user settings based on contents of $_POST
register_new_user()`wp-includes/user.php`	Handles registering a new user.
wp_insert_user()`wp-includes/user.php`	Inserts a user into the database.
wpmu_validate_user_signup()`wp-includes/ms-functions.php`	Sanitizes and validates data required for a user sign-up.

Show 1 more Show less

Changelog

Version	Description
2.1.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Example
If the E-mail exists, echo the ID number to which the E-mail is registered. Otherwise, tell the viewer that it does not exist.
```
$email = 'myemail@example.com';
$exists = email_exists( $email );
if ( $exists ) {
	echo "That E-mail is registered to user number " . $exists;
} else {
	echo "That E-mail doesn't belong to any registered users on this site";
}
```
Log in to add feedback
Skip to note 4 content

pave1 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Bear in mind: this function is not defined in SHORTINIT

Log in to add feedback

email_exists( string $email ): int|false

In this article