`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

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

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Backend\EventListener;

use TYPO3\CMS\Backend\Module\BeforeModuleCreationEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;

#[AsEventListener(
  identifier: 'my-extension/backend/modify-module-icon',
)]
final readonly 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 BeforeModuleCreationEvent

Fully qualified name: \TYPO3\CMS\Backend\Module\BeforeModuleCreationEvent

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

getIdentifier()

Returns: string

getConfiguration()

Returns: array

setConfiguration(array $configuration)

param $configuration: the configuration

hasConfigurationValue(string $key)

param $key: the key

Returns: bool

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

param $key: the key
param $default: the default, default: NULL

Returns: ?mixed

setConfigurationValue(string $key, ?mixed $value)

param $key: the key
param $value: the value