Description

The symfony expression language has been implemented for TypoScript conditions in both frontend and backend since TYPO3 9.4.

Upgrading

The existing conditions are available as variables and/or functions but were already marked as deprecated. So expect deprecation messages when using the old syntax with TYPO3 9. The existing conditions will be removed early in version 10. If you want to know what your conditions did until now, have a look at an older version of this document .

General Usage

To learn the full power of the symfony expression language please check the documentation for the common expression syntax. Here are some examples to understand the power of the expression language:

[page["uid"] in 18..45]
# This condition matches if current page uid is between 18 and 45
[END]

[userId in [1,5,7]]
# This condition matches if current logged in user has the uid 1, 5 or 7
[END]

[not ("foo" matches "/bar/")]
# This condition does match if "foo" **not** matches the regExp: `/bar/`
[END]

[applicationContext == "Production"] && [userId == 15]
# This condition match if application context is "Production" AND logged in user has the uid 15
# This condition could also be combined in one condition:
# [applicationContext == "Production" && userId == 15]
[END]

[request.getNormalizedParams().getHttpHost() == 'typo3.org']
# This condition matches if current hostname is typo3.org
[END]

[like(request.getNormalizedParams().getHttpHost(), "*.devbox.local")]
# This condition matches if current hostname is any subdomain of devbox.local
[END]

[request.getNormalizedParams().isHttps() == false]
# This condition matches if current request is **not** https
[END]

Variables

The following variables are available. The values are context related.

Variable Type Description
applicationContext String current application context as string
page Array current page record as array
{$foo.bar} Constant Any TypoScript constant is available like before. Depending on the type of the constant you have to use different conditions, see examples below: - if constant is an integer: - [{$foo.bar} == 4711] - if constant is a string put constant in quotes: - ["{$foo.bar}" == "4711"]
tree .level .rootLine .rootLineIds Object Integer Array Array object with tree information current tree level array of arrays with uid and pid an array with UIDs of the rootline
backend .user .user.isAdmin .user.isLoggedIn .user.userId .user.userGroupList Object Object Boolean Boolean Integer String object with backend information (available in BE only) object with current backend user information true if current user is admin true if current user is logged in UID of current user comma list of group UIDs
frontend .user .user.isLoggedIn .user.userId .user.userGroupList Object Object Boolean Integer String object with frontend information (available in FE only) object with current frontend user information true if current user is logged in UID of current user comma list of group UIDs
typo3 .version .branch .devIpMask Object String String String object with TYPO3 related information TYPO3_version (e.g. 9.4.0-dev) TYPO3_branch (e.g. 9.4) $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']

Functions

Functions take over the logic of the old conditions which do more than a simple comparison check. The following functions are available in any context:

Function Parameter Description
request .getQueryParams() .getParsedBody() .getHeaders() .getCookieParams() .getNormalizedParams() Custom Object This object provides 4 methods - [request.getQueryParams()['foo'] == 1] - [request.getParsedBody()['foo'] == 1] - [request.getHeaders()['Accept'] == 'json'] - [request.getCookieParams()['foo'] == 1] - [request.getNormalizedParams().isHttps()]
date String Get current date in given format. Examples: - true if day of current month is 7: - [date("j") == 7] - true if day of current week is 7: - [date("w") == 7] - true if day of current year is 7: - [date("z") == 7] - true if current hour is 7: - [date("G") == 7]
like String This function has two parameters: the first parameter is the string to search in the second parameter is the search string Example: - [like("foobarbaz", "bar")]
ip String Value or Constraint, Wildcard or RegExp possible special value: devIP (match the devIPMask
compatVersion String version constraint, e.g. 9.4 or 9.4.0
loginUser String value or constraint, wildcard or RegExp possible Examples: - [loginUser('*')] // any logged in user - [loginUser(1)] // user with uid 1 - [loginUser('1,3,5')] // user 1, 3 or 5 - [loginUser('*') == false] // not logged in
getTSFE Object TypoScriptFrontendController ($GLOBALS['TSFE'])
getenv String PHP function: getenv()
usergroup String value or constraint, wildcard or RegExp possible

The following functions are only available in frontend context:

Function Parameter Description
session String Get value from session Example, matches if session value = 1234567 - [session("session:foo|bar") == 1234567]
site String get value from site configuration, or null if no site was found or property does not exists Example, matches if site identifier = foo - [site("identifier") == "foo"] Example, matches if site base = http://localhost - [site("base") == "http://localhost"]
siteLanguage String get vale from siteLanguage configuration, or null if no site was found or property not exists Example, match if siteLanguage locale = foo - [siteLanguage("locale") == "de_CH"] Example, match if siteLanguage title = Italy - [siteLanguage("title") == "Italy"]

Extending the expression language with own functions (like old userFunc)

It is possible to extend the expression language with own functions like before userFunc in the old conditions. An example could be TYPO3\CMS\Core\ExpressionLanguage\TypoScriptConditionFunctionsProvider which implements the most core functions.

Add new methods by implementing own providers which implement the ExpressionFunctionProviderInterface and register the provider in ext_localconf.php:

if (!is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Core\ExpressionLanguage\TypoScriptConditionProvider']['additionalExpressionLanguageProvider'])) {
   $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Core\ExpressionLanguage\TypoScriptConditionProvider']['additionalExpressionLanguageProvider'] = [];
}
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Core\ExpressionLanguage\TypoScriptConditionProvider']['additionalExpressionLanguageProvider'][] = \My\NameSpace\Provider\TypoScriptConditionProvider::class;