public function UserAuthInterface::authenticate in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/user/src/UserAuthInterface.php \Drupal\user\UserAuthInterface::authenticate()
2. 9 core/modules/user/src/UserAuthInterface.php \Drupal\user\UserAuthInterface::authenticate()

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|bool The user's uid on success, or FALSE on failure to authenticate.

File

core/modules/user/src/UserAuthInterface.php, line 21

Class

UserAuthInterface

An interface for validating user authentication credentials.

Namespace

Drupal\user

Code

public function authenticate($username, $password);