INI files an extension author meets
Part 8, reference 26. The kernel's settings live in settings/*.ini (about 70 files). An extension never edits them;
it adds settings/<file>.ini.append.php files of its own, which the kernel merges in for every active extension
(Settings in an extension). This page lists the files and
sections extensions add to most, by purpose.
The file format of an extension's settings
/* #?ini charset="utf-8"?
[ModuleSettings]
ExtensionRepositories[]=myext
*/ The PHP comment wrapper keeps the file from being served as text. Name[]=value appends to a list; an empty
Name[] line first clears it.
By purpose
| Purpose | File | Section and settings |
|---|---|---|
| Activate extensions | site.ini | [ExtensionSettings] ActiveExtensions[] (in settings/override), ActiveAccessExtensions[] (per siteaccess) |
| Extra extension directories | site.ini | [ExtensionSettings] AdditionalExtensionDirectories[] |
| Event listeners and filters | site.ini | [Event] Listeners[] |
| Template operators and functions | site.ini | [TemplateSettings] ExtensionAutoloadPath[] |
| Translations | site.ini | [RegionalSettings] TranslationExtensions[] |
site.ini | [MailSettings] (the site's; read it, do not set it) | |
| Modules | module.ini | [ModuleSettings] ExtensionRepositories[], ModuleList[] |
| Datatypes | content.ini | [DataTypeSettings] ExtensionDirectories[], AvailableDataTypes[] |
| Custom tags | content.ini | [CustomTagSettings] AvailableCustomTags[] and a section per tag |
| Workflow event types | workflow.ini | [EventSettings] ExtensionDirectories[], AvailableEventTypes[] |
| Cronjob parts | cronjob.ini | [CronjobSettings] ExtensionDirectories[], [CronjobPart-<name>] Scripts[] |
| Designs | design.ini | [ExtensionSettings] DesignExtensions[] |
| Stylesheets and scripts | design.ini | [StylesheetSettings] FrontendCSSFileList[], BackendCSSFileList[]; [JavaScriptSettings] FrontendJavaScriptList[], BackendJavaScriptList[] |
| Template overrides | override.ini | one section per rule (Source, MatchFile, Subdir, Match[...]) |
| Ajax server functions | ezjscore.ini | [ezjscServer_<name>] |
| Admin menus | menu.ini | [Leftmenu_<name>] Links[], LinkNames[], PolicyList_<key>[] |
| Context menus and node tabs | admininterface.ini | [AdditionalMenuSettings] ContextMenuTemplateArray[] ...; [WindowControlsSettings] AdditionalTabs[] and [AdditionalTab_<id>] |
| Registries of the RAD catalogue | rad.ini | [RegistrySettings] and [Registry_<name>] |
| Fetch aliases | fetchalias.ini | a section per alias |
| Help pages | exphelp.ini | README.md and INSTALL.md on top, every other page as Markdown in doc/, shown while the extension is active (The help system for extensions, Documenting an extension) |
| Your own settings | myext.ini | in settings/myext.ini, your own sections |
Other files you may read
| File | Holds |
|---|---|
image.ini | image aliases (sizes) and the image handler |
file.ini | the cluster file handler |
viewcache.ini | which views are cleared on publish |
i18n.ini | character set and translation settings |
template.ini | template engine settings (wash, auto-link) |
debug.ini | debug output conditions |
rest.ini | the REST interface's providers and filters |
velocity.ini | the application server, when used |
Rules
- Your own settings go in your own file, never into a kernel file's sections you do not need.
- Keys and section names are case-sensitive.
- After changing settings, clear the INI cache with
--clear-tag=ini. - Never ship
settings/overridefiles or passwords in an extension.
Related pages
- Previous: Built-in fetch functions by module
- Next: Console commands for developers
- eZINI: reading settings
- How INI settings work
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.