Attention
TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.
Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v10 here: TYPO3 ELTS.
Add TypoScript in your extension
Note
This part is written for extension developers.
Create TypoScript files in your extension
TypoScript files should have the ending .typoscript
.
They are located in Configuration/
within your
extension.
Usually, you will have the following structure:
Configuration/
└── TypoScript
├── constants.typoscript
└── setup.typoscript
constants.
contains the constantstyposcript setup.
contains the TypoScript setuptyposcript
Make TypoScript available for static includes
<?php
defined('TYPO3') or die();
call_user_func(function()
{
$extensionKey = 'myextension';
/**
* Default TypoScript
*/
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile(
$extensionKey,
'Configuration/TypoScript',
'Some descriptive title'
);
});
If you include the TypoScript this way, it will not be automatically loaded. You MUST load it by adding the static include in the Web > Template module in the backend, see Include TypoScript from extensions. This has the advantage of better configurability.
This will load your constants and your setup once the template is included statically.
Tip
You may also want to make several different templates available.
Make TypoScript available (always load)
Only do this, if your TypoScript must really be always loaded in your site. If this is not the case, use the method described in the previous section Make TypoScript available for static includes.
defined('TYPO3') or die();
call_user_func(function()
{
$extensionKey = 'myextension';
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScript(
$extensionKey,
'setup',
"@import 'EXT:myextension/Configuration/TypoScript/setup.typoscript'"
);
});
More information
- TypoScript configuration (in "Sitepackage Tutorial")`
- Extension Configuration (in "Sitepackage Tutorial")`