Validates user authentication credentials.

Parameters

string $username: The user name to authenticate.

string $password: A plain-text password, such as trimmed text from form values.

Return value

int|false The user's uid on success, or FALSE on failure to authenticate.

Overrides UserAuthInterface::authenticate

File

core/modules/user/src/UserAuthentication.php, line 43

Class

UserAuthentication

Validates user authentication credentials.

Namespace

Drupal\user

Code

public function authenticate($username, #[\SensitiveParameter] $password) {
  @trigger_error(__METHOD__ . ' is deprecated in drupal:10.3.0 and will be removed from drupal:12.0.0. Implement \\Drupal\\user\\UserAuthenticationInterface instead. See https://www.drupal.org/node/3411040');
  $uid = FALSE;
  if (!empty($username) && strlen($password) > 0) {
    $account_search = $this->entityTypeManager
      ->getStorage('user')
      ->loadByProperties([
      'name' => $username,
    ]);
    if ($account = reset($account_search)) {
      if ($this->authenticateAccount($account, $password)) {
        $uid = $account->id();
      }
    }
  }
  return $uid;
}

---