ModifyGenericBackendMessagesEvent¶

New in version 12.0: This event serves as direct replacement for the now removed hook $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['displayWarningMessages'].

This Event allows to add or alter messages that are displayed in the “About” module (default start module of the TYPO3 Backend).

Extensions such as the system extension EXT:reports use this Event to display custom messages based on the status of the system:

../../../_images/GenericBackendMessage.png

A generic backend message in the about module

API¶

class TYPO3\CMS\Backend\Controller\Event\ModifyGenericBackendMessagesEvent¶

Listeners to this event are able to add or change messages for the “Help > About” module.

getMessages()¶

Return type:	array

addMessage(TYPO3CMSCoreMessagingAbstractMessage message)¶

Parameters:	$message (TYPO3CMSCoreMessagingAbstractMessage) – the message

setMessages(array messages)¶

Parameters:	$messages (array) – the messages

Example¶

Registration of an event listener in your extensions’ Services.yaml:

my_extension/Configuration/Services.yaml¶

MyVendor\MyExtension\Backend\MyEventListener:
  tags:
    - name: event.listener
      identifier: 'my-package/backend/add-message'

The corresponding event listener class:

my_extension/Classes/Backend/MyEventListener.php¶

use TYPO3\CMS\Backend\Controller\Event\ModifyGenericBackendMessagesEvent;
use TYPO3\CMS\Core\Messaging\FlashMessage;

class MyEventListener {

    public function __invoke(ModifyGenericBackendMessagesEvent $event): void
    {
        // Add a custom message
        $event->addMessage(new FlashMessage('My custom message'));
    }
}