function user_load_by_mail in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/user/user.module \user_load_by_mail()
2. 7 modules/user/user.module \user_load_by_mail()
3. 9 core/modules/user/user.module \user_load_by_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.

See also

\Drupal\user\Entity\User::loadMultiple()

1 call to user_load_by_mail()

_update_cron_notify in core/modules/update/update.fetch.inc

Performs any notifications that should be done once cron fetches new data.

File

core/modules/user/user.module, line 176

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