Attention

TYPO3 v8 has reached its end-of-life March 31st, 2020 and is not maintained by the community anymore. Looking for a stable version? Use the version switch on the top left.

There is no further ELTS support. It is recommended that you upgrade your project and use a supported version of TYPO3.

->OPTIONS

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

dontMountAdminMounts

Property

dontMountAdminMounts

Data type

boolean

Description

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

Note

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

defaultUploadFolder

Property

defaultUploadFolder

Data type

string

Description

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 RTE and its magic images, as well as 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". Example:

options.defaultUploadFolder = 2:user_folders/my_folder/

RTEkeyList

Property

RTEkeyList

Data type

(list of keywords)

Description

This is a list of the Rich Text Editor buttons the user may see displayed. The user will not see any buttons not listed here.

Either enter a comma-separated list of button keywords (see "TYPO3 Core API / RTE section") or set a wildcard "*" to show all.

Default

*

clearCache.pages

Property

clearCache.pages

Data type

boolean

Description

This will allow a non-admin user to clear frontend and page-related caches.

Default

0

clearCache.system

Property

clearCache.system

Data type

boolean

Description

This will allow a non-admin user to clear frontend and page-related caches, plus some backend-related caches (that is everything including templates). This property is equivalent to clearCache.all. Note: this option has been removed on TYPO3 8.7 and above.

Default

0

clearCache.all

Property

clearCache.all

Data type

boolean

Description

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.

Default

0

lockToIP

Property

lockToIP

Data type

string

Description

List of IP-numbers with wildcards.

Note

This option is enabled only if the $TYPO3_CONF_VARS['BE']['enabledBeUserIPLock'] configuration is true.

Examples:

192.168.*.*

- will allow all from 192.168-network

192.168.*.*, 212.22.33.44

- will allow all from 192.168-network plus all from REMOTE_ADDR 212.22.33.44

192.168, 212.22.33.44

- the same as the previous. Leaving out parts of the IP address is the same as wild cards...

saveClipboard

Property

saveClipboard

Data type

boolean

Description

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

clipboardNumberPads

Property

clipboardNumberPads

Data type

integer (0-20)

Description

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

Default

3

enableBookmarks

Property

enableBookmarks

Data type

boolean

Description

Enables the usage of bookmarks in the backend.

Default

1

bookmarkGroups

Property

bookmarkGroups

Data type

Array of integers/ strings

Description

Set groups of bookmarks that can be accessed by the user.

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:

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.

mayNotCreateEditBookmarks

Property

mayNotCreateEditBookmarks

Data type

boolean

Description

If set, the user cannot create or edit bookmarks.

createFoldersInEB

Property

createFoldersInEB

Data type

boolean

Description

If set, a createFolders option appears in the element browser (for admin-users this is always enabled).

noThumbsInEB

Property

noThumbsInEB

Data type

boolean

Description

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

popupWindowSize

Property

popupWindowSize

Data type

string

Description

Defines the size of the element browser.

noThumbsInRTEimageSelect

Property

noThumbsInRTEimageSelect

Data type

boolean

Description

As noThumbsInEB but for the Rich Text Editor image selector.

uploadFieldsInTopOfEB

Property

uploadFieldsInTopOfEB

Data type

boolean

Description

If set, the upload-fields in the element browser are put in the top of the window.

saveDocNew

Property

saveDocNew

saveDocNew.[table]

Data type

boolean / "top"

Description

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

Any value set for a single table will override the default value set to the object "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).

options.saveDocNew = 0
options.saveDocNew.tt_content = top

saveDocView

Property

saveDocView

saveDocView.[table]

Data type

boolean

Description

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

Any value set for a single table will override the default value set to the object "saveDocView".

Default

1

disableDelete

Property

disableDelete

disableDelete.[table]

Data type

boolean

Description

Disables the "Delete" button in TCEFORMs.

Overriding for single tables works like "saveDocNew" above.

showHistory

Property

showHistory

showHistory.[table]

Data type

boolean

Description

Shows link to the history for the record in TCEFORMs.

Overriding for single tables works like "saveDocNew" above.

pageTree.backgroundColor

Property

pageTree.backgroundColor

Data type

string

Description

Set background colors for tree branches.

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

The syntax is: options.pageTree.backgroundColor.<pageId> = <color>

Examples:

options.pageTree.backgroundColor.2 = red
options.pageTree.backgroundColor.3 = #00FFFF
options.pageTree.backgroundColor.4 = rgba(0, 255, 0, 0.1)
Tree branches with configured background colors

Tree branches with configured background colors

pageTree.disableIconLinkToContextmenu

Property

pageTree.disableIconLinkToContextmenu

folderTree.disableIconLinkToContextmenu

Data type

boolean / "titlelink"

Description

If set, the page/folder-icons in the page/folder tree will not activate the clickmenu.

If the value is set "titlelink" then the icon will instead be wrapped with the same link as the title.

pageTree.showPageIdWithTitle

Property

pageTree.showPageIdWithTitle

Data type

boolean

Description

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

pageTree.showDomainNameWithTitle

Property

pageTree.showDomainNameWithTitle

Data type

boolean

Description

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

Property

pageTree.showNavTitle

Data type

boolean

Description

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.showPathAboveMounts

Property

pageTree.showPathAboveMounts

Data type

boolean

Description

If set, the user db mount path above the mount itself is shown.

Active user db mount

This is useful if you work a lot with user db mounts.

pageTree.doktypesToShowInNewPageDragArea

Property

pageTree.doktypesToShowInNewPageDragArea

Data type

string

Description

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

Top panel in normal mode
Top panel modified

Default

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

pageTree.hideFilter

Property

pageTree.hideFilter

Data type

boolean

Description

If set, the filter-box in the top of the page tree will be hidden.

pageTree.altElementBrowserMountPoints

Property

pageTree.altElementBrowserMountPoints

Data type

(list of integers)

Description

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 described below.

Example

options.pageTree.altElementBrowserMountPoints = 34,123

pageTree.altElementBrowserMountPoints.append

Property

pageTree.altElementBrowserMountPoints.append

Data type

boolean

Description

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 UserTSconfig option.

Example

options.pageTree.altElementBrowserMountPoints = 34,123
options.pageTree.altElementBrowserMountPoints.append = 1

pageTree.excludeDoktypes

Property

pageTree.excludeDoktypes

Data type

(list of integers)

Description

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

Example

options.pageTree.excludeDoktypes = 254,1

pageTree.searchInAlias

Property

pageTree.searchInAlias

Data type

boolean

Description

If set, the search in the pagetree (filter tree) also filters on the alias field. Contrary to filtered page titles the search result of alias fields will not be highlighted.

Example

Searching for my- now additionally returns also pages with these string in the alias field.

Filtering the pagetree for my- now additionally returns pages with matched alias fields.

folderTree.altElementBrowserMountPoints

Property

folderTree.altElementBrowserMountPoints

Data type

(list of "storageUid:folderName" items)

Description

Sets alternative filemounts for use in the File List and in Element Browser. Each item consists of storage Uid followed by a colon and the folder name inside that storage. You separate multiple items by a comma.

For backwards compatibility, defining only a folder name but without a storage Uid and colon prepended is still supported as well. 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. Effective in workspaces too.

The alternative filemounts are added to the existing filemounts.

Example

options.folderTree.altElementBrowserMountPoints = _temp_/, 2:/templates, 1:/files/images

folderTree.uploadFieldsInLinkBrowser

Property

folderTree.uploadFieldsInLinkBrowser

Data type

integer

Description

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.

Default

3

folderTree.hideCreateFolder

Property

folderTree.hideCreateFolder

Data type

boolean

Description

If set, the user can't create new folders.

Default

false

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

Property

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

Data type

(list of items)

Description

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

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

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 the other.

Items to disable for "page" type are:

view, edit, new, info, copy, copyRelease, cut, cutRelease, pasteAfter, pasteInto, newWizard, openListModule, mountAsTreeRoot, 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

Example:

options.contextMenu.table.pages.disableItems = new,newWizard

options.contextMenu.table.pages.tree.disableItems = new,newWizard

Note

Context menu rendering was refactored in v8.6, so when migrating from v7 some of the settings needs to be tuned. See chapter in the TYPO3 API documentation regarding new context menu implementation.

overridePageModule

Property

overridePageModule

Data type

string

Description

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

Example:

options.overridePageModule = web_txtemplavoilaM1

This will enable TemplaVoila page module as default page module.

Property

hideModules.[module group]

Data type

(list of module groups or modules)

Description

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

It is not an access restriction but makes defined modules invisible. That means in principle those modules can still be accessed if the rights allow.

Note

A list of all available module groups and modules can be found in in the backend module SYSTEM -> Configuration -> $GLOBALS['TBE_MODULES'] (BE Modules)

Example:

# Hide module groups "file" + "help"
options.hideModules = file, help

# Hide module "func" and "info" from the "web" group
options.hideModules.web := addToList(func,info)

# Hide module BELogLog from "system" group
options.hideModules.system = BelogLog

alertPopups

Property

alertPopups

Data type

bitmask

Description

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)

Default

255 (show all warnings)

defaultFileUploads

Property

defaultFileUploads

Data type

integer

Description

Default number of file upload forms shown in the File->List module

hideRecords.pages

Property

hideRecords.pages

Data type

(list of page ids)

Description

This 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:

options.hideRecords.pages = 12,45

additionalPreviewLanguages

Property

additionalPreviewLanguages

Data type

(list of sys_language ids)

Description

The user will see these additional languages when localizing stuff in TCEforms. The list are uid numbers of sys_language records.

checkPageLanguageOverlay

Property

checkPageLanguageOverlay

Data type

boolean

Description

If set, localized fields in flexforms are shown only for languages which the current page is translated to.

view.languageOrder

Property

view.languageOrder

Data type

(list of sys_language ids)

Description

When a backend user clicks a view-page link in the backend (magnifying glass) the first language uid in this list which the user has access to edit will be added as the parameter "&L=[UID]" to the view-link.

This is a useful setting for translators which primarily wish to see their translation when they click the view-links.

Example:

options.view.languageOrder = 2,1

feedit.popupHeight

Property

feedit.popupHeight

Data type

integer

Description

Sets the height of the popup window of feedit

Example:

options.feedit.popupHeight = 700

feedit.popupWidth

Property

feedit.popupWidth

Data type

integer

Description

Sets the width of the popup window of feedit

Example:

options.feedit.popupWidth = 700

file_list.enableDisplayBigControlPanel

Property

file_list.enableDisplayBigControlPanel

Data type

(list of keywords)

Description

Determines whether the checkbox "Extended view" in the filelist module is shown or hidden. If it is hidden, you can predefine it to be always activated or always deactivated.

Checkbox "Extended view" in the filelist module

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.

Default

selectable

file_list.enableDisplayThumbnails

Property

file_list.enableDisplayThumbnails

Data type

(list of keywords)

Description

Determines whether the checkbox "Display thumbnails" in the filelist 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.

Default

selectable

file_list.filesPerPage

Property

file_list.filesPerPage

Data type

integer

Description

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

Default

40

file_list.enableClipBoard

Property

file_list.enableClipBoard

Data type

(list of keywords)

Description

Determines whether the checkbox "Show clipboard" in the filelist 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.

Default

selectable

impexp.enableImportForNonAdminUser

Property

impexp.enableImportForNonAdminUser

Data type

boolean

Description

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

Default

0