function user_load_by_mail

You are here

7 user.module user_load_by_mail($mail)
8 user.module user_load_by_mail($mail)

Fetch a user object by email address.

Parameters

$mail: String with the account's e-mail address.

Return value

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

See also

user_load_multiple()

2 calls to user_load_by_mail()
system_send_email_action in modules/system/system.module
Sends an e-mail message.
_update_cron_notify in modules/update/update.fetch.inc
Performs any notifications that should be done once cron fetches new data.

File

modules/user/user.module, line 381
Enables the user registration and login system.

Code

function user_load_by_mail($mail) {
  $users = user_load_multiple(array(), array('mail' => $mail));
  return reset($users);
}