user_load_by_mail

user_load_by_mail($mail)

Fetches a user object by email address.

Parameters

string $mail: String with the account's email address.

Return value

object|bool A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.

File

core/modules/user/user.module, line 234: Enables the user registration and login system.

Code

function user_load_by_mail($mail) {
  $users = \Drupal::entityTypeManager()->getStorage('user')
    ->loadByProperties(['mail' => $mail]);
  return $users ? reset($users) : FALSE;
}

Links:

https://api.drupal.org/api/drupal/core%21modules%21user%21user.module/function/user_load_by_mail/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Popular Articles

user_load_by_name user_load_by_name($name) Fetches a user object by account name. Parameters string $name: String with the account's user name. Return value object|b

User::load() $this load(array|string $relations) Eager load relations on the model. Parameters array|string $relations Return Value $this

user_load user_load($uid, $reset = FALSE) Loads a user object. Parameters int $uid: Integer specifying the user ID to load. bool $reset: TRUE to reset the int

user_load_multiple user_load_multiple(array $uids = NULL, $reset = FALSE) Loads multiple users based on certain conditions. This function should be used whenever you ne

user_mail user_mail($key, &$message, $params) Implements hook_mail(). File core/modules/user/user.module, line 910 Enables the user registration and login

user_load_by_mail

Parameters

Return value

See also

File

Code