Feature: #99586 - Registration of upgrade wizards via service tag¶

Description¶

Upgrade wizards are usually used to execute one time migrations when updating a TYPO3 installation. The registration was previously done in an extensions ext_localconf.php file. This has now been improved by introducing the custom PHP attribute TYPO3\CMS\Install\Attribute\UpgradeWizard. All upgrade wizards, defining the new attribute, are automatically tagged and registered in the service container. The registration via $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/install']['update'] has been deprecated.

The registration of an upgrade wizard is therefore now be done directly in the class by adding the new attribute with the upgrade wizards' unique identifier as constructor argument:

use TYPO3\CMS\Install\Attribute\UpgradeWizard;
use TYPO3\CMS\Install\Updates\UpgradeWizardInterface;

#[UpgradeWizard('myUpgradeWizard')]
class MyUpgradeWizard implements UpgradeWizardInterface
{

}

Note

All upgrade wizards have to implement the UpgradeWizardInterface.

Impact¶

It's now possible to tag upgrade wizards with the PHP attribute TYPO3\CMS\Install\Attribute\UpgradeWizard to have them auto-configured and auto-registered.