function 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 1992

Code

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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.