Outdated TYPO3 Version
This documentation refers to an outdated TYPO3 version - either select a supported version or make sure to use a TYPO3 Extended Long Term Support (ELTS) version to continue getting security updates.
ext_emconf.php is the single most important file in an extension.
Without it, the Extension Manager (EM) will not detect the extension, much less
be able to install it. This file contains a declaration of what the extension
is or does for the EM. The only thing included
is an associative array,
The keys are described in the table below.
When extensions are imported from the online repository this file is
written anew! So don’t put any custom stuff in there - only change
values in the
$EM_CONF array if needed.
|title||string, required||The name of the extension in English.|
|description||string, required||Short and precise description in English of what the extension does and for whom it might be useful.|
Which category the extension belongs to:
List of requirements, suggestions or conflicts with other extensions or TYPO3 or PHP version. Here’s how a typical setup might look:
'constraints' => array( 'depends' => array( 'typo3' => '4.5.0-6.1.99', 'php' => '5.3.0-5.5.99' ), 'conflicts' => array( 'dam' => '' ), 'suggests' => array( 'tt_news' => '2.5.0-0.0.0' ) )
The above example indicated that the extension depends on a
version of TYPO3 between 4.5 and 6.1 (as only bug and security fixes are
integrated into TYPO3 when the last digit of the version changes, it is
safe to assume it will be compatible with any upcoming version of the
corresponding branch, thus
Which state is the extension in
|uploadfolder||boolean||If set, then the folder named “uploads/tx_[extKey-with-no- underscore]” should be present!|
|createDirs||list of strings||Comma list of directories to create upon extension installation.|
|clearCacheOnLoad||boolean||If set, the EM will request the cache to be cleared when this extension is loaded.|
|author||string||Author name (Use a-z)|
|author_email||email address||Author email address|
|author_company||string||Author company (if any company sponsors the extension).|
Path to documentation. This has never been fully supported neither by the TER
nor by the Extension Manager. The documentation is expected to be in folder
Compliance level that the extension claims to adhere to. A compliance defines certain coding guidelines, level of documentation, technical requirements (like XHTML, DBAL usage etc).
Any remarks to the compliance status. Might describe some minor incompatibilities or other reservations.
If set, this version of the extension is not included in the public list!
Not supported anymore
If set, this password must additionally be specified if people want to access (import or see details for) this the extension.
Not supported anymore
|version||main.sub.dev||Version of the extension. Automatically managed by EM / TER. Format is [int].[int].[int]|