BeforeModuleCreationEvent¶

The PSR-14 event \TYPO3\CMS\Backend\Module\BeforeModuleCreationEvent allows extension authors to manipulate the module configuration, before it is used to create and register the module.

Example¶

Registration of the event listener in the extension's Services.yaml:

EXT:my_extension/Configuration/Services.yaml

services:
  # Place here the default dependency injection configuration

  MyVendor\MyExtension\Backend\EventListener\MyEventListener:
    tags:
      - name: event.listener
        identifier: 'my-extension/backend/modify-module-icon'

Read how to configure dependency injection in extensions.

The corresponding event listener class:

EXT:my_extension/Classes/Backend/EventListener/MyEventListener.php

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Backend\EventListener;

use TYPO3\CMS\Backend\Module\BeforeModuleCreationEvent;

final class MyEventListener
{
    public function __invoke(BeforeModuleCreationEvent $event): void
    {
        // Change module icon of page module
        if ($event->getIdentifier() === 'web_layout') {
            $event->setConfigurationValue('iconIdentifier', 'my-custom-icon-identifier');
        }
    }
}

API¶

class \TYPO3\CMS\Backend\Module\ BeforeModuleCreationEvent¶

Listeners can adjust the module configuration before the module gets created and registered

getIdentifier ( ) ¶

returntype: string

getConfiguration ( ) ¶

returntype: array

setConfiguration ( array $configuration) ¶

param array $configuration: the configuration

hasConfigurationValue ( string $key) ¶

param string $key: the key
returntype: bool

getConfigurationValue ( string $key, mixed $default = NULL) ¶

param string $key: the key
param mixed $default: the default, default: NULL
returntype: mixed

setConfigurationValue ( string $key, mixed $value) ¶

param string $key: the key
param mixed $value: the value