ext_localconf.php ¶
-- optional
ext_ is always included in global scope of the script,
in the frontend, backend and CLI context.
It should contain additional configuration of $GLOBALS.
This file contains hook definitions and plugin configuration. It must not contain a PHP encoding declaration.
All ext_ files of loaded extensions are
included right after the files typo3conf/
and typo3conf/ during TYPO3
bootstrap.
Pay attention to the rules for the contents of these files. For more details, see the section below.
Should not be used for¶
While you can put functions and classes into ext_,
it considered bad practice because such classes and functions would always be
loaded. Move such functionality to services or utility classes instead.
Registering hooks, XCLASSes or any simple array assignments to
$GLOBALS options will not work for the following:
- class loader
- package manager
- cache manager
- configuration manager
- log manager (= Logging Framework)
- time zone
- memory limit
- locales
- stream wrapper
- error handler
This would not work because the extension files ext_ are
included (load) after the creation of the
mentioned objects in the Bootstrap class.
In most cases, these assignments should be placed in
typo3conf/.
Example:
Register an exception handler:
$GLOBALS['TYPO3_CONF_VARS']['SYS']['debugExceptionHandler'] =
\Vendor\Ext\Error\PostExceptionsOnTwitter::class;Deprecated since version 11.5
Icons should be registered in Icons.php.
See also: IconRegistry
Should be used for¶
These are the typical functions that extension authors should place within
file:ext_
- Registering hooks, XCLASSes
or any simple array assignments to
$GLOBALSoptions['TYPO3_ CONF_ VARS'] - Registering additional Request Handlers within the Bootstrap
- Adding any page TSconfig
- Adding any user TSconfig
- Adding default TypoScript via
\TYPO3\APIsCMS\ Core\ Utility\ Extension Management Utility - Registering Scheduler Tasks
- Adding reports to the reports module
- Registering Services via the Service API
Examples¶
Put a file called ext_ in the main directory of your
Extension. It does not need to be registered anywhere but will be loaded
automatically as soon as the extension is installed.
The skeleton of the ext_ looks like this:
<?php
// all use statements must come first
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
// Prevent Script from being called directly
defined('TYPO3') or die();
// encapsulate all locally defined variables
(function () {
// Add your code here
})();Read why the check for the TYPO3 constant is necessary.
Adding default page TSconfig¶
Default page TSconfig can be added inside ext_, see
Setting the Page TSconfig globally:
//use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
ExtensionManagementUtility::addPageTSConfig();Page TSconfig available via static files can be added inside
Configuration/, see
Static Page TSconfig:
ExtensionManagementUtility::registerPageTSConfigFile();Adding default user TSconfig¶
As for default page TSconfig, user TSconfig can be added inside
ext_, see:
Setting default user TSconfig:
//use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
ExtensionManagementUtility::addUserTSConfig();