function user_uid_optional_load in Drupal 7

Same name and namespace in other branches

1. 6 modules/user/user.module \user_uid_optional_load()

Load either a specified or the current user account.

@todo rethink the naming of this in Drupal 8.

Parameters

$uid: An optional user ID of the user to load. If not provided, the current user's ID will be used.

Return value

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

See also

user_load()

File

modules/user/user.module, line 1978

Enables the user registration and login system.

Code

function user_uid_optional_load($uid = NULL) {
  if (!isset($uid)) {
    $uid = $GLOBALS['user']->uid;
  }
  return user_load($uid);
}