Attention

TYPO3 v12 has reached end-of-life as of April 30th 2026 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.

Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v12 here: TYPO3 ELTS.

BeforeUserLogoutEvent

New in version 12.3

The event replaces the deprecated hook $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'].

The purpose of the PSR-14 event \TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent is to trigger any kind of action before a user will be logged out.

The event has the possibility to bypass the regular logout process by TYPO3 (removing the cookie and the user session) by calling $event->disableRegularLogoutProcess() in an event listener.

Example

Note

Currently, we do not have an example for this event. If you can provide a useful one, please open an issue with your code snippets or a pull request.

API

class BeforeUserLogoutEvent

Fully qualified name: \TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent

Event fired before a user is going to be actively logged out.

An option to interrupt the regular logout flow from TYPO3 Core (so you can do this yourself) is also available.

getUser ( )

Returns: TYPO3CMSCoreAuthenticationAbstractUserAuthentication

disableRegularLogoutProcess ( )

enableRegularLogoutProcess ( )

shouldLogout ( )

Returns: bool

getUserSession ( )

Returns: ?TYPO3CMSCoreSessionUserSession