ModifyNewContentElementWizardItemsEvent¶

New in version 12.0

This event serves as a more powerful and flexible alternative for the removed hook $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms']['db_new_content_el']['wizardItemsHook'].

The PSR-14 event \TYPO3\CMS\Backend\Controller\Event\ModifyNewContentElementWizardItemsEvent is called after TYPO3 has already prepared the wizard items, defined in page TSconfig (mod.wizards.newContentElement.wizardItems).

The event allows listeners to modify any available wizard item as well as adding new ones. It is therefore possible for the listeners to, for example, change the configuration, the position or to remove existing items altogether.

Example¶

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

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Backend\EventListener;

use TYPO3\CMS\Backend\Controller\Event\ModifyNewContentElementWizardItemsEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;

#[AsEventListener(
    identifier: 'my-extension/backend/modify-wizard-items',
)]
final readonly class MyEventListener
{
    public function __invoke(ModifyNewContentElementWizardItemsEvent $event): void
    {
        // Add a new wizard item after "textpic"
        $event->setWizardItem(
            'my_element',
            [
                'iconIdentifier' => 'icon-my-element',
                'title' => 'My element',
                'description' => 'My element description',
                'tt_content_defValues' => [
                    'CType' => 'my_element',
                ],
            ],
            ['after' => 'common_textpic'],
        );
    }
}

New in version 13.0

The PHP attribute \TYPO3\CMS\Core\Attribute\AsEventListener has been introduced to tag a PHP class as an event listener. Alternatively, or if you need to be compatible with older TYPO3 versions, you can also register an event listener via the Configuration/Services.yaml file. Switch to an older version of this page for an example or have a look at the section Implementing an event listener in your extension.

API¶

class ModifyNewContentElementWizardItemsEvent ¶

Fully qualified name: \TYPO3\CMS\Backend\Controller\Event\ModifyNewContentElementWizardItemsEvent

Listeners to this Event will be able to modify the wizard items of the new content element wizard component

getWizardItems ( ) ¶

Returns: array

setWizardItems ( array $wizardItems) ¶

param $wizardItems: the wizardItems

hasWizardItem ( string $identifier) ¶

param $identifier: the identifier

Returns: bool

getWizardItem ( string $identifier) ¶

param $identifier: the identifier

Returns: ?array

setWizardItem ( string $identifier, array $configuration, array $position = []) ¶

Add a new wizard item with configuration at a defined position.

Can also be used to relocate existing items and to modify their configuration.

param $identifier: the identifier
param $configuration: the configuration
param $position: the position, default: []

removeWizardItem ( string $identifier) ¶

param $identifier: the identifier

Returns: bool

getPageInfo ( ) ¶

Provides information about the current page making use of the wizard.

Returns: array

getColPos ( ) ¶

Provides information about the column position of the button that triggered the wizard.

Returns: ?int

getSysLanguage ( ) ¶

Provides information about the language used while triggering the wizard.

Returns: int

getUidPid ( ) ¶

Provides information about the element to position the new element after (uid) or into (pid).

Returns: int