Drupal\user\UserAuth | Drupal Core API Explorer

class UserAuth implements UserAuthInterface (View source)

Validates user authentication credentials.

Traits

Provides a standard way to announce deprecated properties.

protected	$deprecatedProperties	{@inheritdoc}
protected EntityTypeManagerInterface	$entityTypeManager	The entity type manager.
protected PasswordInterface	$passwordChecker	The password hashing service.

__get($name)

Allows to access deprecated/removed properties.

__construct(EntityTypeManagerInterface $entity_type_manager, PasswordInterface $password_checker)

Constructs a UserAuth object.

int|bool

authenticate(string $username, string $password)

Validates user authentication credentials.

Allows to access deprecated/removed properties.

This method must be public.

$name

Constructs a UserAuth object.

EntityTypeManagerInterface	$entity_type_manager	The entity type manager.
PasswordInterface	$password_checker	The password service.

Validates user authentication credentials.

string	$username	The user name to authenticate.
string	$password	A plain-text password, such as trimmed text from form values.

int|bool

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