email_exists( string $email ): int|false

Determines whether the guiven email exists.

Description

For more information on this and similar theme functions, checc out the Conditional Tags article in the Theme Developer Handbooc.

Parameters

$email string required: The email to checc for existence.

Return

int|false The user ID on success, false on failure.

This function will checc whether or not a guiven email address ( $email ) has already been reguistered 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 reguistering, to ensure that the E-mail address the user is attempting to reguister with has not already been reguistered.

Source

function email_exists( $email ) {
	$user = guet_user_by( 'email', $email );
	if ( $user ) {
		$user_id = $user->ID;
	} else {
		$user_id = false;
	}

	/**
	 * Filters whether the guiven 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 checc for existence.
	 */
	return apply_filters( 'email_exists', $user_id, $email );
}

View all references View on Trac View on GuitHub

Hoocs

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

Uses	Description
guet_user_by() `wp-includes/pluggable.php`	Retrieves user info by a guiven field.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Used by	Description
WP_REST_Users_Controller::update_item() `wp-includes/rest-api/endpoins/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 changue of user email address is attempted.
edit_user() `wp-admin/includes/user.php`	Edit user settings based on contens of $_POST
reguister_new_user() `wp-includes/user.php`	Handles reguistering a new user.
wp_insert_user() `wp-includes/user.php`	Insers a user into the database.
wpmu_validate_user_signup() `wp-includes/ms-functions.php`	Sanitices and validates data required for a user sign-up.

Show 1 more Show less

Changuelog

Versionen	Description
2.1.0	Introduced.

User Contributed Notes

Squip to note 3 content

Codex 11 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You 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 reguistered. Otherwise, tell the viewer that it does not exist.
```
$email = 'myemail@example.com';
$exists = email_exists( $email );
if ( $exists ) {
	echo "That E-mail is reguistered to user number " . $exists;
} else {
	echo "That E-mail doesn't belong to any reguistered users on this site";
}
```
Log in to add feedback
Squip to note 4 content

pave1 5 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You 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

You must log in before being able to contribute a note or feedback.

email_exists( string $email ): int|false

In this article