options

Various options for the user affecting the Core at various points.

As an example, this enables the Flush frontend caches button in the upper right toolbar cache menu for non-admin users:

EXT:site_package/Configuration/user.tsconfig
options.clearCache.pages = 1

Properties

additionalPreviewLanguages

additionalPreviewLanguages
Data type

list of sys_language IDs

The user will see these additional languages when localizing stuff in TCEforms. The list are IDs of site languages, as defined in the languageId property of the site configuration.

alertPopups

alertPopups
Data type

bitmask

Default

255 (show all warnings)

Configure which Javascript popup alerts have to be displayed and which not:

  • 1 – onTypeChange

  • 2 – copy / move / paste

  • 4 – delete

  • 8 – FE editing

  • 128 – other (not used yet)

bookmarkGroups

bookmarkGroups
Data type

Array of integers / strings

Set groups of bookmarks that can be accessed by the user. This affects the bookmarks toolbar item in the top right of the backend.

By default, 5 default groups will be defined globally (shared, can only be set by admins) and also for each user (personal bookmarks):

  1. Pages

  2. Records

  3. Files

  4. Tools

  5. Miscellaneous

Set 0 to disable one of these group IDs, 1 to enable it (this is the default) or "string" to change the label accordingly.

Example:

EXT:site_package/Configuration/user.tsconfig
bookmarkGroups {
  1 = 1
  2 = My Group
  3 = 0
  4 =
}

Bookmark group 1 is loaded with the default label (Pages), group 2 is loaded and labeled as "My Group" and groups 3 and 4 are disabled. Group 5 has not been set, so it will be displayed by default, just like group 1.

New in version 11.0.

Custom language labels can also be used instead of a fixed label:

EXT:site_package/Configuration/user.tsconfig
bookmarkGroups {
  2 = LLL:EXT:sitepackage/Resources/Private/Language/locallang_be.xlf:bookmarkGroups.2
}

clearCache

clearCache.all

clearCache.all
Data type

boolean

Default

0

This will allow a non-admin user to clear frontend and page-related caches, plus some backend-related caches (that is everything including templates); if it is explicitly set to 0 for an admin user, it will remove the clear all option on toolbar for that user.

clearCache.pages

clearCache.pages
Data type

boolean

Default

0

If set to 1, this will allow a non-admin user to clear frontend and page-related caches.

clipboardNumberPads

clipboardNumberPads
Data type

integer (0-20)

Default

3

This allows you to enter how many pads you want on the clipboard.

contextMenu disableItems

contextMenu.table.[tableName][.context].disableItems
Data type

list of items

List of context menu ("clickmenu") items to disable.

Context menu of the page tree

Context menu of the page tree

The [tableName] refers to the type of the record (database table name) the context menu is shown for, for example, pages, sys_file, tt_content, etc.

The optional key [.context] refers to the place from which the context menu is triggered. The Core uses just one context called tree for context menus triggered from page tree and folder tree. This way you can disable certain options for one context, but keep them for another.

Items to disable for "page" type are:

  • view

  • edit

  • new

  • info

  • copy

  • copyRelease

  • cut

  • cutRelease

  • pasteAfter

  • pasteInto

  • newWizard

  • pagesSort

  • pagesNewMultiple

  • openListModule

  • mountAsTreeRoot

  • hideInMenus

  • showInMenus

  • permissions

  • enable

  • disable

  • delete

  • history

  • clearCache

Items to disable for "sys_file" type (that is files/folders) are:

  • edit

  • rename

  • upload

  • new

  • info

  • copy

  • copyRelease

  • cut

  • cutRelease

  • pasteInto

  • delete

When the system extension Import/Export (EXT:impexp) is installed then two more options become available:

  • exportT3d

  • importT3d

Example:

EXT:site_package/Configuration/user.tsconfig
# Remove "New" and "Create New wizard" for pages context menu (list module)
options.contextMenu.table.pages.disableItems = new,newWizard

# Remove "New" and "Create New wizard" in page tree context menu
options.contextMenu.table.pages.tree.disableItems = new,newWizard

# Remove the "More options" item in the page tree context menu and all its subelements
options.contextMenu.table.pages.tree.disableItems = newWizard, pagesSort, pagesNewMultiple, openListModule, mountAsTreeRoot, exportT3d, importT3d, hideInMenus, showInMenus, permissions

createFoldersInEB

Changed in version 12.4: With the migration of the "Create folder" view into a separate modal used in EXT:filelist, which is based on the element browser as well, this option became useless and is not evaluated anymore.

dashboard

dashboard.dashboardPresetsForNewUsers

dashboard.dashboardPresetsForNewUsers
Data type

list of dashboard identifiers

Default

default

List of dashboard identifiers to be used on initial dashboard module access.

Example:

EXT:site_package/Configuration/user.tsconfig
options.dashboard.dashboardPresetsForNewUsers := addToList(customDashboard)

defaultUploadFolder

defaultUploadFolder
Data type

string

When a user uploads files they are stored in the default upload folder of the first file storage that user may access. The folder is used for uploads in the TCEforms fields. In general, this will be fileadmin/user_upload/.

With this property it is possible to set a specific upload folder.

The syntax is "storage_uid:file_path".

Note

It is also possible to set a default upload folder for a page via page TSconfig.

Example:

EXT:site_package/Configuration/user.tsconfig
options.defaultUploadFolder = 2:user_folders/my_folder/

disableDelete

disableDelete
Data type

boolean

Disables the Delete button in TCEFORMs.

Note, it is possible to set this for single tables using options.disableDelete.<tableName>. Any value set for a single table will override the default value set for disableDelete.

Example:

EXT:site_package/Configuration/user.tsconfig
options.disableDelete.tt_content = 1

dontMountAdminMounts

dontMountAdminMounts
Data type

boolean

This options prevents the root to be mounted for an admin user.

Note

Only for admin users. For other users it has no effect.

enableBookmarks

enableBookmarks
Data type

boolean

Default

1

Enables the usage of bookmarks in the backend.

file_list

file_list.enableClipBoard

file_list.enableClipBoard
Data type

list of keywords

Default

selectable

Determines whether the checkbox Show clipboard in the file list module is shown or hidden. If it is hidden, you can predefine it to be always activated or always deactivated.

The following values are possible:

activated

The option is activated and the checkbox is hidden.

deactivated

The option is deactivated and the checkbox is hidden.

selectable

The checkbox is shown so that the option can be selected by the user.

file_list.displayColumnSelector

file_list.displayColumnSelector
Data type

boolean

Default

true

The column selector is enabled by default and can be disabled with this option. The column selector is displayed at the top of each file list.

It can be used to manage the fields displayed for each file / folder, while containing convenience actions such as "filter", "check all / none" and "toggle selection".

The fields to be selected are a combination of special fields, such as references or read/write permissions, the corresponding sys_file record fields, as well as all available sys_file_metadata fields.

Example:

EXT:site_package/Configuration/user.tsconfig
# Disable the column selector
file_list.displayColumnSelector = 0

file_list.enableDisplayBigControlPanel

Changed in version 11.3: The checkbox Extended view was removed with TYPO3 v11.3. Therefore the option file_list.enableDisplayBigControlPanel has no effect anymore.

file_list.enableDisplayThumbnails

file_list.enableDisplayThumbnails
Data type

list of keywords

Default

selectable

Determines whether the checkbox Display thumbnails in the file list module is shown or hidden. If it is hidden, you can predefine it to be always activated or always deactivated.

The following values are possible:

activated

The option is activated and the checkbox is hidden.

deactivated

The option is deactivated and the checkbox is hidden.

selectable

The checkbox is shown so that the option can be selected by the user.

file_list.filesPerPage

file_list.filesPerPage
Data type

integer

Default

40

The maximum number of files shown per page in the File > List module.

file_list.primaryActions

file_list.primaryActions
Data type

string

Default

view,metadata,translations,delete

Option to add more primary actions to the list view. The list of actions to be displayed can be given in the TSConfig of the backend user. The actions that can be added are

  • view

  • metadata

  • delete

  • copy

  • cut

translations is always active.

file_list.thumbnail.height

file_list.thumbnail.height
Data type

integer

Default

64

All preview images in the file list will be rendered with the configured thumbnail height.

file_list.thumbnail.width

file_list.thumbnail.width
Data type

integer

Default

64

All preview images in the file list will be rendered with the configured thumbnail width.

file_list.uploader.defaultAction

file_list.uploader.defaultAction
Data type

string

Default

Cancel

Default action for the modal that appears when during file upload a name collision occurs. Possible values:

Cancel

Abort the action.

Rename

Append the file name with a numerical index.

Replace

Override the file with the uploaded one.

folderTree

folderTree.altElementBrowserMountPoints

folderTree.altElementBrowserMountPoints
Data type

list of "storageUid:folderName" items

Sets alternative filemounts for use in any folder tree, including in the File > List module, in the element browser and in file selectors.

Each item consists of storage UID followed by a colon and the folder name inside that storage. Separate multiple items by a comma.

For backwards compatibility, defining only a folder name but no storage uid and colon prepended is still supported. Folders without a storage UID prepended are assumed to be located in the default storage, which by default is the fileadmin/ folder. If a folder you specify does not exist it will not get mounted.

Settings this option is effective in workspaces too.

The alternative file mounts are added to the existing ones defined in the user or group configuration.

Example:

EXT:site_package/Configuration/user.tsconfig
options.folderTree.altElementBrowserMountPoints = _temp_/, 2:/templates, 1:/files/images

folderTree.hideCreateFolder

Changed in version 12.4: With the migration of the "Create folder" view into a separate modal used in EXT:filelist, which is based on the element browser as well, this option became useless and is not evaluated anymore.

folderTree.uploadFieldsInLinkBrowser

folderTree.uploadFieldsInLinkBrowser
Data type

integer

Default

3

This value defines the number of upload fields in the element browser. Default value is 3, if set to 0, no upload form will be shown.

hideModules

Changed in version 12.0: In TYPO3 versions before 12.0 the hideModules option was appended with the module group. This changed with the introduction of the new module registration API in TYPO3 v12. If you are using an older version of TYPO3 please use the version switcher on the top left of this document to go to the respective version.

hideModules
Data type

list of module groups or modules

Configure which module groups or modules should be hidden from the main menu.

Attention

It is not an access restriction but makes defined modules invisible. This means that in principle these modules can still be accessed if the rights allow this.

Hint

A list of all available module groups and modules can be found in in the backend module System > Configuration > Backend Modules. The system extension "lowlevel" has to be available for accessing this list.

Example:

EXT:site_package/Configuration/user.tsconfig
# Hide only module groups "file" and "help"
options.hideModules = file, help

# Hide additional modules "info" and "ts" from the "web" group
options.hideModules := addToList(web_info, web_ts)

# Hide only module BeLogLog from "system" group
options.hideModules = system_BelogLog

hideRecords

hideRecords.pages

hideRecords.pages
Data type

list of page IDs

This setting hides records in the backend user interface. It is not an access restriction but makes defined records invisible. That means in principle those records can still be edited if the user rights allow. This makes sense if only a specialized module should be used to edit those otherwise hidden records.

This option is currently implemented for the pages table only and has an effect in the following places:

  • Page tree navigation frame

  • Web > List module

  • New record wizard

Example:

EXT:site_package/Configuration/user.tsconfig
options.hideRecords.pages = 12,45

impexp

impexp.enableExportForNonAdminUser

New in version 10.4.29/11.5.11: This option was introduced to avoid information disclosure.

impexp.enableExportForNonAdminUser
Data type

boolean

Default

0

The import/export module of EXT:impexp is disabled by default for non-admin users. Enable this option, if non-admin users need to use the module and export data. This should only be enabled for trustworthy backend users, as it might impose a security risk.

impexp.enableImportForNonAdminUser

This option was introduced to avoid information disclosure.

impexp.enableImportForNonAdminUser
Data type

boolean

Default

0

The import/export module of EXT:impexp is disabled by default for non-admin users. Enable this option, if non-admin users need to use the module and import data. This should only be enabled for trustworthy backend users, as it might impose a security risk.

mayNotCreateEditBookmarks

mayNotCreateEditBookmarks
Data type

boolean

If set, the user can not create or edit bookmarks.

noThumbsInEB

noThumbsInEB
Data type

boolean

If set, then image thumbnails are not shown in the element browser.

overridePageModule

overridePageModule
Data type

string

By this value you can substitute the default Web > Page module key ("web_layout") with another backend module key.

Note

This property has been introduced for EXT:templavoila in the old days. It is of little use nowadays and can be achieved using hideModules, too.

Example:

EXT:site_package/Configuration/user.tsconfig
# Enable TemplaVoila page module as default page module.
options.overridePageModule = web_txtemplavoilaM1

pageTree

pageTree.altElementBrowserMountPoints

pageTree.altElementBrowserMountPoints
Data type

list of integers

Sets alternative webmounts for use in the element browser. You separate page IDs by a comma. Non-existing page IDs are ignored. If you insert a non-integer it will evaluate to "0" (zero) and the root of the page tree is mounted. Effective in workspaces too.

These alternative webmounts replace configured DB mount points unless you use the altElementBrowserMountPoints.append option.

Example:

EXT:site_package/Configuration/user.tsconfig
options.pageTree.altElementBrowserMountPoints = 34,123

pageTree.altElementBrowserMountPoints.append

pageTree.altElementBrowserMountPoints.append
Data type

boolean

This option allows administrators to add additional mount points in the RTE and the wizard element browser instead of replacing the configured database mount points of the user when using the existing user TSconfig option.

Example:

EXT:site_package/Configuration/user.tsconfig
options.pageTree.altElementBrowserMountPoints = 34,123
options.pageTree.altElementBrowserMountPoints.append = 1

pageTree.backgroundColor

pageTree.backgroundColor
Data type

string

Set background colors for tree branches.

The color can be any valid CSS color value. The best results can be achieved by using RGBa values.

Example:

EXT:site_package/Configuration/user.tsconfig
# The syntax is:
# options.pageTree.backgroundColor.<pageId> = <color>
options.pageTree.backgroundColor.147 = orange
options.pageTree.backgroundColor.148 = #AFAFAF
options.pageTree.backgroundColor.151 = rgba(0, 255, 0, 0.1)
Tree branches with configured background colors

Tree branches with configured background colors

pageTree.doktypesToShowInNewPageDragArea

pageTree.doktypesToShowInNewPageDragArea
Data type

string

Default

1,6,4,7,3,254,255,199

If set, the node top panel feature can be configured by a comma-separated list. Each number stands for a doktype ID that should be added to the node top panel.

Top panel in normal mode

Top panel in normal mode

Top panel modified

Top panel modified

pageTree.excludeDoktypes

pageTree.excludeDoktypes
Data type

list of integers

Excludes nodes (pages) with one of the defined doktypes from the page tree. Can be used, for example, for hiding custom doktypes.

Example:

EXT:site_package/Configuration/user.tsconfig
options.pageTree.excludeDoktypes = 254,1

pageTree.showDomainNameWithTitle

pageTree.showDomainNameWithTitle
Data type

boolean

If set, the domain name will be appended to the page title for pages that have Is root of web site? checked in the page properties. Useful if there are several domains in one page tree.

pageTree.showNavTitle

pageTree.showNavTitle
Data type

boolean

If set, the navigation title is displayed in the page navigation tree instead of the normal page title. The page title is showed in a tooltip if the mouse hovers the navigation title.

pageTree.showPageIdWithTitle

pageTree.showPageIdWithTitle
Data type

boolean

If set, the titles in the page tree will have their ID numbers printed before the title.

pageTree.showPathAboveMounts

pageTree.showPathAboveMounts
Data type

boolean

If set, the user db mount path above the mount itself is shown. This is useful if you work a lot with user db mounts.

Active user db mount

Active user db mount

passwordReset

passwordReset
Data type

boolean

Default

1

If set to 0 the initiating of the password reset in the backend will be disabled. This does not affect the password reset by CLI command.

To completely disable the password reset in the backend for all users, you can set the user TSconfig globally in your ext_localconf.php:

EXT:site_package/ext_localconf.php
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addUserTSConfig(
    'options.passwordReset = 0'
);

If required, this setting can be overridden on a per user basis in the corresponding TSconfig field of the backend usergroup or user.

The password reset functionality can also be disabled globally by setting:

config/system/settings.php | typo3conf/system/settings.php
$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = false

saveClipboard

saveClipboard
Data type

boolean

If set, the clipboard content will be preserved for the next login. Normally the clipboard content lasts only during the session.

saveDocNew

saveDocNew
Data type

boolean / "top"

Default

1

If set, a button Save and create new will appear in TCEFORMs.

Note, it is possible to set this for single tables using options.saveDocNew.[tableName]. Any value set for a single table will override the default value set for saveDocNew.

Example:

In this example the button is disabled for all tables, except tt_content where it will appear, and in addition create the records in the top of the page (default is after instead of top).

EXT:site_package/Configuration/user.tsconfig
options.saveDocNew = 0
options.saveDocNew.tt_content = top

saveDocView

saveDocView
Data type

boolean

Default

1

If set, a button Save and view will appear in TCEFORMs.

Note, it is possible to set this for single tables using options.saveDocView.[tableName]. Any value set for a single table will override the default value set for saveDocView.

showDuplicate

showDuplicate
Data type

boolean

Default

0

If set, a button Duplicate will appear in TCEFORMs.

Note, that it is possible to set this for single tables using options.showDuplicate.[tableName]. Any value set for a single table will override the default value set for showDuplicate.

showHistory

showHistory
Data type

boolean

Shows link to the history for the record in TCEFORMs.

Note, it is possible to set this for single tables using options.showHistory.[tableName]. Any value set for a single table will override the default value set for showHistory.