BeforeModuleCreationEvent

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

Registration of an event listener in the Services.yaml:

EXT:my_extension/Configuration/Services.yaml
MyVendor\MyExtension\Backend\ModifyModuleIcon:
  tags:
    - name: event.listener
      identifier: 'my-extension/backend/modify-module-icon'

The corresponding event listener class:

EXT:my_extension/Classes/Backend/ModifyModuleIcon.php
use TYPO3\CMS\Backend\Module\BeforeModuleCreationEvent;

final class ModifyModuleIcon {

    public function __invoke(BeforeModuleCreationEvent $event): void
    {
        // Change module icon of page module
        if ($event->getIdentifier() === 'web_layout') {
            $event->setConfigurationValue('iconIdentifider', '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()
Return type

string

getConfiguration()
Return type

array

setConfiguration(array configuration)
Parameters
  • $configuration (array) -- the configuration

hasConfigurationValue(string key)
Parameters
  • $key (string) -- the key

Return type

bool

getConfigurationValue(string key, mixed default = NULL)
Parameters
  • $key (string) -- the key

  • $default (mixed) -- the default, default: NULL

Return type

mixed

setConfigurationValue(string key, mixed value)
Parameters
  • $key (string) -- the key

  • $value (mixed) -- the value