function user_load
Same name in other branches
- 8.9.x core/modules/user/user.module \user_load()
Loads a user object.
Drupal 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 drupal_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
58 calls to user_load()
- comment_tokens in modules/
comment/ comment.tokens.inc - Implements hook_tokens().
- ContactPersonalTestCase::testPersonalContactAccess in modules/
contact/ contact.test - Tests access to the personal contact form.
- DrupalRenderTestCase::testDrupalRenderCache in modules/
simpletest/ tests/ common.test - Tests caching of render items.
- DrupalWebTestCase::setUp in modules/
simpletest/ drupal_web_test_case.php - Sets up a Drupal site for running functional and integration tests.
- EntityCrudHookTestCase::testUserHooks in modules/
simpletest/ tests/ entity_crud_hook_test.test - Tests hook invocations for CRUD operations on users.
File
-
modules/
user/ user.module, line 365
Code
function user_load($uid, $reset = FALSE) {
$users = user_load_multiple(array(
$uid,
), array(), $reset);
return reset($users);
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.