ext_tables.php

ext_tables.php

ext_tables.php
Scope
extension
Path (Composer)
packages/my_extension/ext_tables.php
Path (Classic)
typo3conf/ext/my_extension/ext_tables.php

ext_tables.php is not always included in the global scope of the frontend context.

This file is only included when

  • a TYPO3 Backend or CLI request is happening
  • or the TYPO3 Frontend is called and a valid backend user is authenticated

This file usually gets included later within the request and after TCA information is loaded, and a backend user is authenticated.

Should not be used for

Should be used for

These are the typical functions that should be placed inside ext_tables.php

Examples

Put the following in a file called ext_tables.php in the main directory of your extension. The file does not need to be registered but will be loaded automatically:

EXT:site_package/ext_tables.php 
<?php

declare(strict_types=1);

use MyVendor\MyExtension\Backend\MyClass;

defined('TYPO3') or die();

// Add your code here
MyClass::doSomething();
Copied!

Read why the check for the TYPO3 constant is necessary.

Registering a scheduler task

Scheduler tasks get registered in ext_tables.php as well. Note that the system extension "scheduler" has to be installed for this to work.

EXT:site_package/ext_tables.php 
<?php

declare(strict_types=1);

use TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider;
use TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionTask;

defined('TYPO3') or die();

$lll = 'LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:';

// Add caching framework garbage collection task
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks']
        [CachingFrameworkGarbageCollectionTask::class] = [
            'extension' => 'my_extension',
            'title' => $lll . 'cachingFrameworkGarbageCollection.name',
            'description' => $lll . 'cachingFrameworkGarbageCollection.description',
            'additionalFields' =>
                CachingFrameworkGarbageCollectionAdditionalFieldProvider::class,
        ];
Copied!

Registering a backend module

Changed in version 12.0

If your extension needs to provide compatibility with TYPO3 v11 as well as v12 you can check which version is loaded in the ext_tables.php and call ExtensionUtility::registerModule for v11 to register an Extbase backend module:

EXT:my_extension/ext_tables.php 
// use TYPO3\CMS\Extbase\Utility\ExtensionUtility;

ExtensionUtility::registerModule(
   'ExtensionName', // Extension Name in CamelCase
   'web', // the main module
   'mysubmodulekey', // Submodule key
   'bottom', // Position
   [
       'MyController' => 'list,show,new',
   ],
   [
       'access' => 'user,group',
       'icon'   => 'EXT:my_extension/ext_icon.svg',
       'labels' => 'LLL:EXT:my_extension/Resources/Private/Language/locallang_statistics.xlf',
   ]
);
Copied!

Allowing a tables records to be added to Standard pages

Changed in version 12.0

The usage of ExtensionManagementUtility::allowTableOnStandardPages() is deprecated. The method will be removed in TYPO3 v13.0. Use TCA ctrl option ignorePageTypeRestriction instead.

If your extension needs to provide compatibility with TYPO3 v11 as well as v12 you can check which version is loaded in the ext_tables.php and call allowTableOnStandardPages for v11:

EXT:site_package/ext_tables.php 
<?php

declare(strict_types=1);

use TYPO3\CMS\Core\Information\Typo3Version;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

defined('TYPO3') or die();

$versionInformation = GeneralUtility::makeInstance(Typo3Version::class);

if ($versionInformation->getMajorVersion() < 12) {
    ExtensionManagementUtility::allowTableOnStandardPages(
        'tx_myextension_domain_model_mymodel',
    );
}
Copied!