function AuthenticationProviderInterface::authenticate

Same name and namespace 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. 11.x 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.

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.