Conditions

See also

applicationContext

applicationContext
Data type

String

The current application context as a string. See Application context.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[applicationContext == "Development"]

Any context that is "Production" or starts with "Production" (eg Production/Staging").

EXT:site_package/Configuration/TypoScript/setup.typoscript
[applicationContext matches "/^Production/"]

page

Note

page is only available in the frontend context. As the TypoScript setup may be loaded in some backend modules or the CLI context, it is considered best practice to always guard the property by using the function traverse()

page
Data type

Array

All data of the current page record as array.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# Check single page uid
[traverse(page, "uid") == 2]

# Check list of page uids
[traverse(page, "uid") in [17,24]]

# Check list of page uids NOT in
[traverse(page, "uid") not in [17,24]]

# Check range of pages (example: page uid from 10 to 20)
[traverse(page, "uid") in 10..20]

# Check the page backend layout
[traverse(page, "backend_layout") == 5]
[traverse(page, "backend_layout") == "example_layout"]

# Check the page title
[traverse(page, "title") == "foo"]

Constant

{$foo.bar}
Data type

Constant

Any TypoScript constant is available like before. Depending on the type of the constant you have to use different conditions.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# If constant is an integer
[{$foo.bar} == 4711]

# If constant is a string, put constant in quotes
["{$foo.bar}" == "4711"]

tree

tree
Data type

Object

Object with tree information.

tree.level

tree.level
Data type

Integer

The current tree level.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[tree.level == 0]

tree.pagelayout

New in version 11.0.

tree.pagelayout
Data type

Integer / String

Check for the defined backend layout of a page, including the inheritance of the field Backend Layout (subpages of this page).

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# Using backend_layout records
[tree.pagelayout == 2]
  page.1 = TEXT
  page.1.value = Layout 2
[END]

# Using TSconfig provider of backend layouts
[tree.pagelayout == "pagets__Home"]
  page.1 = TEXT
  page.1.value = Layout Home
[END]

tree.rootLine

tree.rootLine
Data type

Array

Array of arrays with UID and PID.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[tree.rootLine[0]["uid"] == 1]

tree.rootLineIds

tree.rootLineIds
Data type

Array

An array with UIDs of the root line.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[2 in tree.rootLineIds]

tree.rootLineParentIds

New in version 10.3: This implements the old PIDupinRootline condition within the Symfony expression language, see Feature: #88962 - Re-implement old PIDupinRootline TypoScript condition

tree.rootLineParentIds
Data type

Array

An array with parent UIDs of the root line.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[2 in tree.rootLineParentIds]

backend

backend
Data type

Object

Object with backend information.

backend.user

backend.user
Data type

Object

Object with current backend user information.

backend.user.isAdmin

backend.user.isAdmin
Data type

Boolean

True, if the current backend user is administrator.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[backend.user.isAdmin]

backend.user.isLoggedIn

backend.user.isLoggedIn
Data type

Boolean

True, if the current backend user is logged in.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[backend.user.isLoggedIn]

backend.user.userId

backend.user.userId
Data type

Integer

UID of the the current backend user.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[backend.user.userId == 5]

backend.user.userGroupIds

backend.user.userGroupIds
Data type

Array

Context

Frontend, backend

Array of user group IDs assigned to the current backend user.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[2 in backend.user.userGroupIds]

backend.user.userGroupList

New in version 11.2: Starting with TYPO3 v11.2 backend.user.userGroupIds, an array, has been added. Use this instead of like expressions to test for the user group of the current backend user.

backend.user.userGroupList
Data type

String

Comma-separated list of group UIDs.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[like(","~backend.user.userGroupList~",", "*,1,*")]

frontend

frontend
Data type

Object

Object with frontend information.

frontend.user

frontend.user
Data type

Object

Object with current frontend user information.

frontend.user.isLoggedIn

frontend.user.isLoggedIn
Data type

Boolean

True, if the current frontend user is logged in.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[frontend.user.isLoggedIn]

frontend.user.userId

frontend.user.userId
Data type

Integer

The UID of the current frontend user.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[frontend.user.userId == 5]

frontend.user.userGroupIds

frontend.user.userGroupIds
Data type

Array

Context

Frontend

Array of user group IDs of the current frontend user.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[4 in frontend.user.userGroupIds]

frontend.user.userGroupList

New in version 11.2: Starting with TYPO3 v11.2 frontend.user.userGroupIds, an array has been added. Use this instead of like expressions to test for the user group of the current frontend user.

frontend.user.userGroupList
Data type

String

Comma-separated list of group UIDs.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[like(","~frontend.user.userGroupList~",", "*,1,*")]

workspace

workspace
Data type

Object

Object with workspace information.

workspace.workspaceId

workspace.workspaceId
Data type

Integer

UID of the current workspace.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[workspace.workspaceId == 0]

workspace.isLive

workspace.isLive
Data type

Boolean

True, if the current workspace is the live workspace.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[workspace.isLive]

workspace.isOffline

workspace.isOffline
Data type

Boolean

True, if the current workspace is offline.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[workspace.isOffline]

typo3

typo3
Data type

Object

Object with TYPO3-related information.

typo3.version

typo3.version
Data type

String

TYPO3_version (for example, 11.5.33)

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[typo3.version == "11.5.33"]

typo3.branch

typo3.branch
Data type

String

TYPO3 branch (for example, 11.5)

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[typo3.branch == "11.5"]

typo3.devIpMask

typo3.devIpMask
Data type

String

$GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[typo3.devIpMask == "172.18.0.6"]

date()

date()
Parameter

String

Data type

String | Integer

Get the current date in the given format. See the PHP date function as a reference for the possible usage.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# True, if the day of the current month is 7
[date("j") == 7]

# True, if the day of the current week is 7
[date("w") == 7]

# True, if the day of the current year is 7
[date("z") == 7]

# True, if the current hour is 7
[date("G") == 7]

like()

like()
Parameter

String, String

Data type

Boolean

This function has two parameters: The first parameter is the string to search in, the second parameter is the search string.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# Search a string with * within another string
[like("fooBarBaz", "*Bar*")]

# Search string with single characters in between, using ?
[like("fooBarBaz", "f?oBa?Baz")]

# Search string using regular expression
[like("fooBarBaz", "/f[o]{2,2}[aBrz]+/")]

traverse()

traverse()
Parameter

Array, String

Data type

Mixed

This function gets a value from an array with arbitrary depth and suppresses a PHP warning when sub-arrays do not exist. It has two parameters: The first parameter is the array to traverse, the second parameter is the path to traverse.

In case the path is not found in the array, an empty string is returned.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# Traverse query parameters of current request along tx_news_pi1[news]
[request && traverse(request.getQueryParams(), 'tx_news_pi1/news') > 0]

Tip

Checking for the request object to be available before using traverse() may be necessary, for example, when using Extbase repositories in CLI context (as Extbase depends on TypoScript and on the command line is no request object available). This avoids the error Unable to call method "getQueryParams" of non-object "request".

compatVersion()

compatVersion()
Parameter

String

Data type

Boolean

Compares against the current TYPO3 branch.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# True, if the current TYPO3 version is 12.4.x
[compatVersion("12.4")]

# True, if the current TYPO3 version is 12.4.5
[compatVersion("12.4.5")]

getTSFE()

getTSFE()
Data type

Object

Provides access to TypoScriptFrontendController $GLOBALS['TSFE']. This function can directly access methods of TypoScriptFrontendController. This class is target of a mid-term refactoring. It should be used with care since it will eventually vanish in the future.

Using the getTSFE() function, developers have to ensure that "TSFE" is available before accessing its properties. A missing "TSFE", for example, in backend context, does no longer automatically evaluate the whole condition to false. Instead, the function returns null, which can be checked using either [getTSFE() && getTSFE().id == 17] or the null-safe operator [getTSFE()?.id == 17].

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# True, if the current page UID is 17. Use the page variable instead
[getTSFE()?.id == 17]

getenv()

getenv()
Data type

String

PHP function getenv.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[getenv("VIRTUAL_HOST") == "www.example.org"]

feature()

feature()
Data type

String

Provides access to the current state of feature toggles.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# True, if the feature toggle for enforcing the Content Security Policy
# in the frontend is enabled
[feature("security.frontend.enforceContentSecurityPolicy") === true]

ip()

ip()
Parameter

String

Data type

Boolean

Value or constraint, wildcard or regular expression possible; special value: "devIP" (matches the devIPmask).

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[ip("172.18.*")]
    page.10.value = Your IP matches "172.18.*"
[END]

[ip("devIP")]
    page.10.value = Your IP matches the configured devIp
[END]

request

request()
Data type

Mixed

Allows to fetch information from current request.

Tip

Checking for the request object before using in a condition may be necessary, for example, when using Extbase repositories in CLI context (as Extbase depends on TypoScript and on the command line is no request object available). This avoids, for example, the error Unable to call method "getQueryParams" of non-object "request".

request.getQueryParams()

request.getQueryParams()
Data type

Array

Allows to access GET parameters from current request.

Assuming the following query within URL:

route=%2Fajax%2Fsystem-information%2Frender&token=5c53e9b715362e7b0c3275848068133b89bbed77&skipSessionUpdate=1

the following array would be provided:

Key: route

Value: /ajax/system-information/render

Key: token

Value: 5c53e9b715362e7b0c3275848068133b89bbed77

Key: skipSessionUpdate

Value: 1

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && request.getQueryParams()['skipSessionUpdate'] == 1]

Safely check the query parameter array to avoid error logs in case key is not defined (see traverse()). This will check if the GET parameter tx_news_pi1[news] in the URL is greater than 0:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && traverse(request.getQueryParams(), 'tx_news_pi1/news') > 0]

request.getParsedBody()

request.getParsedBody()
Data type

Array

Provide all values contained in the request body, for example, in case of submitted form via POST, the submitted values.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && traverse(request.getParsedBody(), 'foo') == 1]

request.getHeaders()

request.getHeaders()
Data type

Array

Provide all values from request headers.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && request.getHeaders()['Accept'] == 'json']
  page.10.value = Accepts json
[END]

[request && request.getHeaders()['host'][0] == 'www.example.org']
  page.20.value = The host is www.example.org
[END]

request.getCookieParams()

request.getCookieParams()
Data type

Array

Provides available cookies.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && request.getCookieParams()['foo'] == 1]

request.getNormalizedParams()

request.getNormalizedParams()
Data type

Array

Provides access to the \TYPO3\CMS\Core\Http\NormalizedParams object. Have a look at the normalized parameters of the request object for a list of the available methods.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && request.getNormalizedParams().isHttps()]
  page.10.value = HTTPS is being used
[END]

[request && request.getNormalizedParams().getHttpHost() == "example.org"]
  page.10.value = The host is "example.org"
[END]

request.getPageArguments()

request.getPageArguments()
Data type

Object

Get the current \TYPO3\CMS\Core\Routing\PageArguments object with the resolved route parts from enhancers.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[request && request.getPageArguments().get('foo_id') > 0]

Allows migration from old condition syntax using [globalVar = GP:singlepartner > 0] to [request && request.getPageArguments().get('singlepartner') > 0].

loginUser

Note

This method is deprecated in TYPO3 v12.4. The transition can be done in existing TYPO3 v11 projects already. You should use either frontend.user to test for frontend user state (available in frontend TypoScript), or backend.user (available in frontend TypoScript and TSconfig).

loginUser
Parameter

String

Data type

Boolean

Value or constraint, wildcard or RegExp possible

Context dependent, uses backend user within TSconfig, and frontend user within TypoScript.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[loginUser('*')]
  # matches any login user
  page.10.value = You are logged in!
[END]

[loginUser(1)]
  page.10.value = Your frontend user has the uid 1
[END]

[loginUser('1,3,5')]
  page.10.value = Your frontend user has the uid 1, 3 or 5
[END]

[loginUser('*') == false]
  page.10.value = You are logged out!
[END]

usergroup

Note

This method is deprecated in TYPO3 v12.4. The transition can be done in existing TYPO3 v11 projects already. You should use either frontend.user to test for frontend user state (available in frontend TypoScript), or backend.user (available in frontend TypoScript and TSconfig).

usergroup
Parameter

String

Data type

Boolean

Value or constraint, wildcard or RegExp possible.

Allows to check whether current user (FE or BE) is part of the expected usergroup.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
# Any usergroup
[usergroup("*")]
  page.10.value = You are logged in and belong to some usergroup.
[END]

[usergroup("12")]
  page.10.value = You are in the usergroup with uid 12.
[END]

[usergroup("12,15,18")]
  page.10.value = You are in the usergroup with uid 12, 15 or 18.
[END]

session()

session()
Parameter

String

Data type

Mixed

Allows to access values of the current session. Available values depend on values written to the session, for example, by extensions. Use | to dig deeper into the structure for stored values.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[session("foo|bar") == 1234567]

site()

site()
Parameter

String

Data type

Mixed

Get a value from the site configuration, or null, if no site was found or the property does not exists.

Available Information:

site("identifier")

Returns the identifier of current site as string.

site("base")

Returns the base of current site as string.

site("rootPageId")

Returns the root page uid of current site as integer.

site("languages")

Returns array of available languages for current site. For deeper information, see siteLanguage().

site("allLanguages")

Returns an array of available and unavailable languages for the current site. For deeper information, see siteLanguage().

site("defaultLanguage")

Returns the default language for current site. For deeper information, see siteLanguage().

site("configuration")

Returns an array with all available configuration for current site.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[site("identifier") == "typo395"]

Matches if site base host:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[site("base").getHost() == "www.example.org"]

Base path:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[site("base").getPath() == "/"]

Rootpage uid:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[site("rootPageId") == 1]

Configuration property:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[traverse(site("configuration"), "myCustomProperty") == true]

Warning

It might seem straight-forward to use site("configuration")["myCustomProperty"] to access configuration properties. However, if the property has not been set, this will trigger a runtime exception, and your log will fill up quickly. Using traverse() will silence the error messages.

siteLanguage()

siteLanguage()
Parameter

String

Data type

Mixed

Get a value from the site language configuration, or null if no site was found or property not exists.

Available information:

  • siteLanguage("languageId")

  • siteLanguage("locale")

  • siteLanguage("base")

  • siteLanguage("title")

  • siteLanguage("navigationTitle")

  • siteLanguage("flagIdentifier")

  • siteLanguage("typo3Language") : default or 2 letter language code

  • siteLanguage("twoLetterIsoCode") : 2 letter language code

  • siteLanguage("hreflang")

  • siteLanguage("direction")

  • siteLanguage("fallbackType")

  • siteLanguage("fallbackLanguageIds")

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript
[siteLanguage("locale") == "de_CH"]
  page.10.value = This site has the locale "de_CH"
[END]

[siteLanguage("title") == "Italy"]
  page.10.value = This site has the title "Italy"
[END]