BeforeModuleCreationEvent¶

Example¶

Registration of the event listener in the extension's 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:

<?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 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