Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

INI files an extension author meets

Which kernel INI file and section an extension adds to for each purpose - site, module, content, workflow, cronjob, design, override, ezjscore, menu, admininterface, rad - and how append files work.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/extension-development/part-8-reference/ini-files-for-extension-authors.md

On this page

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

<?php /* #?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

PurposeFileSection and settings
Activate extensionssite.ini[ExtensionSettings] ActiveExtensions[] (in settings/override), ActiveAccessExtensions[] (per siteaccess)
Extra extension directoriessite.ini[ExtensionSettings] AdditionalExtensionDirectories[]
Event listeners and filterssite.ini[Event] Listeners[]
Template operators and functionssite.ini[TemplateSettings] ExtensionAutoloadPath[]
Translationssite.ini[RegionalSettings] TranslationExtensions[]
Mailsite.ini[MailSettings] (the site's; read it, do not set it)
Modulesmodule.ini[ModuleSettings] ExtensionRepositories[], ModuleList[]
Datatypescontent.ini[DataTypeSettings] ExtensionDirectories[], AvailableDataTypes[]
Custom tagscontent.ini[CustomTagSettings] AvailableCustomTags[] and a section per tag
Workflow event typesworkflow.ini[EventSettings] ExtensionDirectories[], AvailableEventTypes[]
Cronjob partscronjob.ini[CronjobSettings] ExtensionDirectories[], [CronjobPart-<name>] Scripts[]
Designsdesign.ini[ExtensionSettings] DesignExtensions[]
Stylesheets and scriptsdesign.ini[StylesheetSettings] FrontendCSSFileList[], BackendCSSFileList[]; [JavaScriptSettings] FrontendJavaScriptList[], BackendJavaScriptList[]
Template overridesoverride.inione section per rule (Source, MatchFile, Subdir, Match[...])
Ajax server functionsezjscore.ini[ezjscServer_<name>]
Admin menusmenu.ini[Leftmenu_<name>] Links[], LinkNames[], PolicyList_<key>[]
Context menus and node tabsadmininterface.ini[AdditionalMenuSettings] ContextMenuTemplateArray[] ...; [WindowControlsSettings] AdditionalTabs[] and [AdditionalTab_<id>]
Registries of the RAD cataloguerad.ini[RegistrySettings] and [Registry_<name>]
Fetch aliasesfetchalias.inia section per alias
Help pagesexphelp.iniREADME.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 settingsmyext.iniin settings/myext.ini, your own sections

Other files you may read

FileHolds
image.iniimage aliases (sizes) and the image handler
file.inithe cluster file handler
viewcache.iniwhich views are cleared on publish
i18n.inicharacter set and translation settings
template.initemplate engine settings (wash, auto-link)
debug.inidebug output conditions
rest.inithe REST interface's providers and filters
velocity.inithe 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/override files or passwords in an extension.

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x