function AuthenticationProviderInterface::authenticate

Same name in other branches
  1. 9 core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php \Drupal\Core\Authentication\AuthenticationProviderInterface::authenticate()
  2. 8.9.x core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php \Drupal\Core\Authentication\AuthenticationProviderInterface::authenticate()
  3. 10 core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php \Drupal\Core\Authentication\AuthenticationProviderInterface::authenticate()

Authenticates the user.

Parameters

\Symfony\Component\HttpFoundation\Request|null $request: The request object.

Return value

\Drupal\Core\Session\AccountInterface|null AccountInterface - in case of a successful authentication. NULL - in case where authentication failed.

7 methods override AuthenticationProviderInterface::authenticate()
Auth::authenticate in core/modules/locale/tests/modules/early_translation_test/src/Auth.php
AuthenticationManager::authenticate in core/lib/Drupal/Core/Authentication/AuthenticationManager.php
BasicAuth::authenticate in core/modules/basic_auth/src/Authentication/Provider/BasicAuth.php
Cookie::authenticate in core/modules/user/src/Authentication/Provider/Cookie.php
TestAuth::authenticate in core/modules/rest/tests/modules/rest_test/src/Authentication/Provider/TestAuth.php

... See full list

File

core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php, line 34

Class

AuthenticationProviderInterface
Interface for authentication providers.

Namespace

Drupal\Core\Authentication

Code

public function authenticate(Request $request);

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