interface UserAuthInterface

Same name and namespace in other branches
  1. 9 core/modules/user/src/UserAuthInterface.php \Drupal\user\UserAuthInterface
  2. 8.9.x core/modules/user/src/UserAuthInterface.php \Drupal\user\UserAuthInterface
  3. 11.x core/modules/user/src/UserAuthInterface.php \Drupal\user\UserAuthInterface

An interface for validating user authentication credentials.

Hierarchy

Expanded class hierarchy of UserAuthInterface

All classes that implement UserAuthInterface

3 files declare their use of UserAuthInterface
BasicAuth.php in core/modules/basic_auth/src/Authentication/Provider/BasicAuth.php
UserAuthenticationController.php in core/modules/user/src/Controller/UserAuthenticationController.php
UserLoginForm.php in core/modules/user/src/Form/UserLoginForm.php

File

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

Namespace

Drupal\user
View source 
interface UserAuthInterface {
    
    /**
     * Validates user authentication credentials.
     *
     * @param string $username
     *   The user name to authenticate.
     * @param string $password
     *   A plain-text password, such as trimmed text from form values.
     *
     * @return int|bool
     *   The user's uid on success, or FALSE on failure to authenticate.
     */
    public function authenticate($username, $password);
    
    /**
     * Validates user authentication credentials for an account.
     *
     * This can be used where the account has already been located using the login
     * credentials.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The account to authenticate.
     * @param string $password
     *   A plain-text password, such as trimmed text from form values.
     *
     * @return bool
     *   TRUE on success, FALSE on failure.
     */
    public function authenticateAccount(UserInterface $account, string $password) : bool;

}

Members

Title Modifiers Object type Summary
UserAuthInterface::authenticate public function Validates user authentication credentials.
UserAuthInterface::authenticateAccount public function Validates user authentication credentials for an account.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.