function user_load_multiple in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/user/user.module \user_load_multiple()

Loads multiple users based on certain conditions.

This function should be used whenever you need to load more than one user from the database. Users are loaded into memory and will not require database access if loaded again during the same page request.

Parameters

array $uids: (optional) An array of entity IDs. If omitted, all entities are loaded.

bool $reset: A boolean indicating that the internal cache should be reset. Use this if loading a user object which has been altered during the page request.

Return value

array An array of user objects, indexed by uid.

See also

entity_load_multiple()

\Drupal\user\Entity\User::load()

user_load_by_mail()

user_load_by_name()

\Drupal\Core\Entity\Query\QueryInterface

File

core/modules/user/user.module, line 190

Enables the user registration and login system.

Code

function user_load_multiple(array $uids = NULL, $reset = FALSE) {
  if ($reset) {
    \Drupal::entityManager()
      ->getStorage('user')
      ->resetCache($uids);
  }
  return User::loadMultiple($uids);
}