1. interface
  2. Drupal
  3. \
  4. user
  5. \
  6. UserAuthInterface

UserAuthInterface

interface UserAuthInterface (View source)

An interface for validating user authentication credentials.

Methods

int|bool
authenticate(string $username, string $password)

Validates user authentication credentials.

Details

at line 21
int|bool authenticate(string $username, string $password)

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.