1.20.x user.module | user_load($uid, $reset = FALSE) |
Loads a user object.
Backdrop has a global $user object, which represents the currently-logged-in user. So to avoid confusion and to avoid clobbering the global $user object, it is a good idea to assign the result of this function to a different local variable, generally $account. If you actually do want to act as the user you are loading, it is essential to call backdrop_save_session(FALSE); first. See Safely impersonating another user for more information.
Parameters
$uid: Integer specifying the user ID to load.
$reset: TRUE to reset the internal cache and load from the database; FALSE (default) to load from the internal cache, if set.
Return value
A fully-loaded user object upon successful user load, or FALSE if the user: cannot be loaded.
See also
File
- modules/
user/ user.module, line 293 - Enables the user registration and login system.
Code
function user_load($uid, $reset = FALSE) {
$users = user_load_multiple(array($uid), array(), $reset);
return reset($users);
}