Skip to content

docs: add docs for programmatic logout #17328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 16, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1723,6 +1723,49 @@ Next, you need to create a route for this URL (but not a controller):
That's it! By sending a user to the ``app_logout`` route (i.e. to ``/logout``)
Symfony will un-authenticate the current user and redirect them.

Logout programmatically
-----------------------

.. versionadded:: 6.2

The :class:`Symfony\Bundle\SecurityBundle\Security\Security <Symfony\\Bundle\\SecurityBundle\\Security\\Security>`
class was introduced in Symfony 6.2. Prior to 6.2, it was called
``Symfony\Component\Security\Core\Security``.

.. versionadded:: 6.2

The :method:`Symfony\\Bundle\\SecurityBundle\\Security\\Security::logout`
method was introduced in Symfony 6.2.

You can logout user programmatically using the `logout()` method of the
:class:`Symfony\\Bundle\\SecurityBundle\\Security\\Security` helper. The user will be logout from the current firewall
in the request. If the current request is not behind a firewall a ``\LogicException`` will be thrown. ::

// src/Controller/SecurityController.php
namespace App\Controller\SecurityController;

use App\Security\Authenticator\ExampleAuthenticator;
use Symfony\Bundle\SecurityBundle\Security\Security;

class SecurityController
{
public function someAction(Security $security): Response
{
// logout the user in on the current firewall
$response = $this->security->logout();

// You can also disable the csrf logout
$response = $this->security->logout(false);

if ($response !== null) {
return $response;
}

// Redirect to the homepage for instance
// ...
}
}

Customizing Logout
~~~~~~~~~~~~~~~~~~

Expand Down