Attention

TYPO3 v7 has reached its end-of-life November 30th, 2018 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.

Condition reference

browser

Note: This condition is deprecated since TYPO3 7.0! Use conditional CSS includes or a userFunc condition and a project like WURFL instead.

Syntax:

[browser = browser1,browser2,...]

Values and comparison:

Browser:	Identification:
Amaya	amaya
AOL	aol
Avant	avant
Camino	camino
Google Chrome	chrome
Mozilla Firefox	firefox
Flock	flock
Gecko	gecko
Konqueror	konqueror
Lynx	lynx
NCSA Mosaic	mosaic
Microsoft Internet Explorer	msie
Navigator	navigator
Netscape Communicator	netscape
OmniWeb	omniweb
Opera	opera
Safari	safari
SeaMonkey	seamonkey
Webkit	webkit
?? (if none of the above was found in the user agent)	unknown

Comparison with the browser, which the website visitor uses.

The condition works with the user agent string. The user agent is parsed with a regular expression, which searches the string for matches with the identifications named above. If there are multiple matches, the rightmost match is finally used, because it mostly is the most correct one.

An example user agent could look like this:

Mozilla/5.0 (Windows NT 10.0; WOW64; rv:38.0) Gecko/20100101 Firefox/38.0

This string contains the identifications "Gecko" and "Firefox". The condition

[browser = firefox]

evaluates to true.

Examples:

This will match with Chrome and Opera browsers:

[browser = chrome, opera]

version

Note: This condition is deprecated since TYPO3 7.0! Use conditional CSS includes or a userFunc condition and a project like WURFL instead.

Syntax:

[version = value1, >value2, =value3, <value4, ...]

Comparison:

Comparison with the browser version, which the website visitor uses.

Values are floating-point numbers with "." as the decimal separator.

The values may be preceded by three operators:

Operator:	Function:
[nothing]	The value must be part of the beginning of the version as a string. This means that if the version is "4.72" and the value is "4" or "4.7" it matches. But "4.73" does not match. Example from syntax: "value1"
=	The value must match exactly. Version "4.72" matches only with a value of "4.72"
>	The version must be greater than the value
<	The version must be less than the value

Examples:

This matches with exactly "8.03" browsers

[version = =8.03]

This matches with all browser versions below 8 and Internet Explorer 8

[version = <8][browser = msie8]

system

Note: This condition is deprecated since TYPO3 7.0! Use conditional CSS includes or a userFunc condition and a project like WURFL instead.

Syntax:

[system = system1,system2]

Values and comparison:

System:	Identification:
Linux	linux
Android	android
OpenBSD/NetBSD/FreeBSD	unix_bsd
SGI / IRIX	unix_sgi
SunOS	unix_sun
HP-UX	unix_hp
Chrome OS	chrome
iOS	iOS
Macintosh	mac
Windows 8	win8
Windows 7	win7
Windows Vista	winVista
Windows XP	winXP
Windows 2000	win2k
Windows NT	winNT
Windows 98	win98
Windows 95	win95
Windows 3.11	win311
Amiga	amiga

Comparison with the operating system, which the website visitor uses. The system is extracted out of the useragent string.

Values are strings and a match happens if one of these strings is the first part of the system-identification.

For example if the value is "win" this will match with all Windows systems.

Examples:

This will match with Windows and Mac systems only

[system = win,mac]

device

Note: This condition is deprecated since TYPO3 7.1! Use conditional CSS includes or a userFunc condition and a project like WURFL instead.

Syntax:

[device = device1, device2]

Values and comparison:

Device:	Identification:
HandHeld	pda
WAP phones	wap
Grabbers	grabber
Indexing robots	robot

Comparison with the website visitor's device.

Values are strings and a match happens if one of these strings equals the type of device.

Examples:

This will match WAP-phones and PDA's

[device = wap, pda]

useragent

Note: This condition is deprecated since TYPO3 7.0! Use conditional CSS includes or a userFunc condition and a project like WURFL instead.

Syntax:

[useragent = agent]

Values and comparison:

This is a direct match on the website visitor's useragent string from getenv('HTTP_USER_AGENT').

You have the options of putting a "*" at the beginning and/or end of the value agent thereby matching with this wildcard!

Examples:

If the HTTP_USER_AGENT is "Mozilla/4.0 (compatible; Lotus-Notes/6.0; Windows-NT)" this will match with it:

[useragent = Mozilla/4.0 (compatible; Lotus-Notes/6.0; Windows-NT)]

This will also match with it:

[useragent = *Lotus-Notes*]

... but this will also match with a useragent like this: "Lotus- Notes/5.0 ( Windows-NT )"

A short list of user-agent strings and a proper match:

HTTP_USER_AGENT:	Agent description:	Matching condition:
Mozilla/5.0 (iPhone; CPU iPhone OS 7_0 like Mac OS X)	Apple iPhone	[useragent = *iPhone*]
Lotus-Notes/6.0 ( Windows-NT )	Lotus-Notes browser	[useragent = Lotus-Notes*]
Mozilla/3.0 (compatible; AvantGo 3.2)	AvantGo browser	[useragent = *AvantGo*]
Mozilla/4.0 (compatible; WebCapture 3.0; Auto; Windows)	Adobe Acrobat	[useragent = *WebCapture*]

WAP-agents:

These are some WAP agents:

HTTP_USER_AGENT:
Alcatel-BE3/1.0 UP/4.0.6c	QWAPPER/1.0
Device V1.12	SIE-IC35/1.0
EricssonR320/R1A	SIE-P35/1.0 UP/4.1.2a
Java1.2.2	UP.Browser/3.01-IG01
Mitsu/1.1.A	WapView 0.47
Nokia-WAP-Toolkit/1.2
Nokia7110/1.0

language

Syntax:

[language = lang1, lang2, ...]

Comparison:

Comparison with the website visitor's preferred languages.

The values must be a straight match with the value of getenv('HTTP_ACCEPT_LANGUAGE') from PHP. Alternatively, if the value is wrapped in "*" (e.g. "*en-us*") then it will split all languages found in the HTTP_ACCEPT_LANGUAGE string and try to match the value with any of those parts of the string. Such a string normally looks like "de,en-us;q=0.7,en;q=0.3" and "*en-us*" would match with this string.

IP

Syntax:

[IP = ipaddress1, ipaddress2, ...]

Comparison:

Comparison with the IP address, which the website visitor uses.

The values are compared with getenv('REMOTE_ADDR') from PHP.

You may include "*" instead of one of the parts in values. You may also list the first one, two or three parts and only they will be tested.

The IP condition also supports the special keyword "devIP". If - instead of using an actual IP address or range - you use this keyword, the IP address, which the visitor uses, will be compared to $TYPO3_CONF_VARS['SYS']['devIPmask'] as set in the Install Tool.

Examples:

These examples will match any IP address starting with "123":

[IP = 123.*.*.*]

or

[IP = 123]

These examples will match any IP address ending with "123" or being "192.168.1.34":

[IP = *.*.*.123][IP = 192.168.1.34]

This example will match the IP address or range defined in $TYPO3_CONF_VARS['SYS']['devIPmask']:

[IP = devIP]

hostname

Syntax:

[hostname = hostname1, hostname2, ...]

Comparison:

Comparison with the hostname, which the website visitor uses.

The values are compared to the fully qualified hostname, which is retrieved by PHP based on getenv('REMOTE_HOST').

Value is comma-list of domain names to match with. *-wildcard allowed but cannot be part of a string, so it must match the full host name (e.g. login.*.org => correct, login.*example.org => wrong)

applicationContext

Syntax:

[applicationContext = context1, context2, ...]

Comparison:

Comparison with the application context, in which TYPO3 is running.

The values are compared to applicationContext, which is set at the very beginning of the bootstrap sequence based on getenv('TYPO3_CONTEXT').

Value is comma-list of application contexts to match with. Wildcards + and * are allowed, as well as regular expressions delimited with /PREG_PATTERN/.

Examples:

Matches exactly the applicationContexts "Development/Debugging" or "Development/Profiling":

[applicationContext = Development/Debugging, Development/Profiling]

Matches any applicationContext with a rootContext of "Production", for example "Production/Live" or "Production/Staging":

[applicationContext = Production*]

Matches any applicationContext starting with "Production/Staging/Server" and ending with one digit, for example "Production/Staging/Server3":

[applicationContext = /^Production\/Staging\/Server\d+$/]

hour

Syntax:

[hour = hour1, > hour2, < hour3, ...]

Note: The first "=" sign directly after the word "hour" is always needed and is no operator. After that follow the operator and then the hour.

Comparison:

Possible values are 0 to 23 (24-hours-format). The values in floating point are compared with the current hour of the server time.

As you see in the section "Syntax" above, you can separate multiple conditions in one with a comma. The comma will then connect them with a logical disjunction (OR), that means the whole condition will be true, when one or more of its operands are true.

Operator:	Function:
[none]	Requires an exact match with the value. Comparison with a list of values is possible as well. The condition then returns true, if the value is in the list. Values must then be separated by "|".
>	The hour must be greater than the value.
<	The hour must be less than the value.
<=	The hour must be less than or equal to the value.
=>	The hour must be greater than or equal to the value.
!=	The hour must be not equal to the value. Comparison with a list of values is possible as well. The condition then returns true, if the value is not in the list. Values must then be separated by "|".

Examples:

This will match, if it is between 9 and 10 o'clock (according to the server time):

[hour = 9]

This will match, if it is not between 8 and 11 o'clock:

[hour = != 8|9|10]

This will match, if it is before 7 o'clock:

[hour = < 7]

This will match, if it is before 15 o'clock:

[hour = <= 14]

The following examples will demonstrate the usage of the comma inside the condition:

This will match, if it is between 8 and 9 o'clock (the hour equals 8) or after 16 o'clock (the hour is bigger than or equal to 16):

[hour = 8, >= 16]

This will match between 16 and 8 o'clock (remember that the comma acts as an OR):

[hour = > 15, < 8]

In contrast a condition matching for 8 until 16 o'clock would be:

[hour = > 7] && [hour = < 16]

minute

See "Hour" above. Uses the same syntax!

Syntax:

[minute = ...]

Comparison:

Minute of hour, possible values are 0-59.

Apart from that this condition uses the same way of comparison as hour.

month

See "Hour" above. Uses the same syntax!

Syntax:

[month = ...]

Comparison:

Month, from January being 1 until December being 12.

Apart from that this condition uses the same way of comparison as hour.

year

See "Hour" above. Uses the same syntax!For further information look at the date() function in the PHP manual, format string Y.

Syntax:

[year = ...]

Comparison:

Year, as a 4-digit number.

Apart from that this condition uses the same way of comparison as hour.

dayofweek

See "Hour" above. Uses the same syntax!

Syntax:

[dayofweek = ...]

Comparison:

Day of week, starting with Sunday being 0 until Saturday being 6.

Apart from that this condition uses the same way of comparison as hour.

dayofmonth

See "Hour" above. Uses the same syntax!

Syntax:

[dayofmonth = ...]

Comparison:

Day of month, possible values are 1-31.

Apart from that this condition uses the same way of comparison as hour.

dayofyear

See "Hour" above. Uses the same syntax!For further information look at the date() function in the PHP manual, format string z.

Syntax:

[dayofyear = ...]

Comparison:

Day of year, 0-364 (or 365 in leap years). That this condition begins with 0 for the first day of the year means that e.g. [dayofyear = 5] will be true on the 6 ^th of January.

Apart from that this condition uses the same way of comparison as hour.

usergroup

Syntax:

[usergroup = group1-uid, group2-uid, ...]

Comparison:

This matches on the uid of a usergroup of a logged in frontend user.

The comparison can only return true if the grouplist is not empty (global var "gr_list").

The values must either exist in the grouplist OR the value must be a "*".

Example:

This matches all FE logins:

[usergroup = *]

This matches logins of frontend users, which are members of frontend user groups with uid's 1 and/or 2:

[usergroup = 1,2]

loginUser

Syntax:

[loginUser = fe_users-uid, fe_users-uid, ...]

Comparison:

Matches on the uid of a logged in frontend user. Works like 'usergroup' above including the * wildcard to select ANY user.

Example:

This matches any FE login (use this instead of "[usergroup = *]" to match when a FE user is logged in!):

[loginUser = *]

Additionally it is possible to check if no FE user is logged in.

Example:

This matches when no FE user is logged in:

[loginUser = ]

page

Syntax:

[page|field = value]

Comparison:

This condition checks values of the current page record. While you can achieve the same with TSFE:[field] conditions in the frontend, this condition is usable in both frontend and backend.

Example:

This condition matches, if the layout field is set to 1:

[page|layout = 1]

treeLevel

Syntax:

[treeLevel = levelnumber, levelnumber, ...]

Comparison:

This checks if the last element of the rootLine is at a level corresponding to one of the figures in "treeLevel". Level = 0 is the "root" of a website. Level = 1 is the first menu level.

Example:

This condition matches, if the page viewed is on either level 0 (root) or on level 2

[treeLevel = 0,2]

PIDinRootline

Syntax:

[PIDinRootline = pages-uid, pages-uid, ...]

Comparison:

This checks if one of the figures in "treeLevel" is a PID (pages-uid) in the rootline.

Example:

This condition matches, if the page viewed is or is a subpage to page 34 or page 36

[PIDinRootline = 34,36]

PIDupinRootline

Syntax:

[PIDupinRootline = pages-uid, pages-uid, ...]

Comparison:

Does the same as PIDinRootline, except the current page-uid is excluded from check.

compatVersion

Syntax:

[compatVersion = x.y.z]

Comparison:

Comparison with the compatibility version of the TYPO3 installation.

Require a minimum compatibility version; the condition will match, if the set compatibility version is higher than or equal to x.y.z. The compatibility version is not necessarily equal to the TYPO3 version, which is used. Instead, it is a configurable value that can be changed in the Upgrade Wizard of the Install Tool.

"compatVersion" is especially useful if you want to provide new default settings but keep the backwards compatibility for old versions of TYPO3.

globalVar

Syntax:

[globalVar = var1 = value1, var2 > value2, var3 < value3, var4 <= value4, ...]

Comparison:

The values in floating point are compared to the global variables "var1", "var2" ... from above.

You can use multiple conditions in one by separating them with a comma. The comma then acts as a logical disjunction, that means the whole condition evaluates to true, whenever one or more of its operands are true.

Operator:	Function:
=	Requires an exact match with the value. Comparison with a list of values is possible as well. The condition then returns true, if the value is in the list. Values must then be separated by "|".
>	The var must be greater than the value.
<	The var must be less than the value.
<=	The var must be less than or equal to the value.
>=	The var mast be greater than or equal to the value.
!=	The var must be not equal to the value. Comparison with a list of values is possible as well. The condition then returns true, if the value is not in the list. Values must then be separated by "|".

Examples:

This will match, if the page-id is equal to either 10, 12 or 15:

[globalVar = TSFE:id = 10|12|15]

This will match, if the page-id is not equal to 10, 12 and 15:

[globalVar = TSFE:id != 10|12|15]

This will match, if the page-id is higher than or equal to 10:

[globalVar = TSFE:id >= 10]

This will match, if the page-id is not equal to 316:

[globalVar = TSFE:id != 316]

This will match with the pages having the layout field set to "Layout 1":

[globalVar = TSFE:page|layout = 1]

This will match with a URL like "...&print=1":

[globalVar = GP:print > 0]

This will match the non-existing GET/POST variable "style":

[globalVar = GP:style = ]

This will match, if the GET/POST variable "L" equals 8 or the GET/POST variable "M" equals 2 or both:

[globalVar = GP:L = 8, GP:M = 2]

Similar to GP, but with array parts of tx_demo from GET and POST merged before matching:

[globalVar = GPmerged:tx_demo|foo = 1]

This will only check POST parameters:

[globalVar = _POST|tx_myext_pi1|showUid > 0]

This will only check GET parameters:

[globalVar = _GET|tx_myext_pi1|showUid > 0]

If the constant {$constant_to_turnSomethingOn} is "1" then this matches:

[globalVar = LIT:1 = {$constant_to_turnSomethingOn}]

Find out if there currently is a valid backend login:

[globalVar = TSFE:beUserLogin = 1]

This will match only with the backend user with UID 13:

[globalVar = BE_USER|user|uid = 13]

globalString

Syntax:

[globalString = var1=value, var2= *value2, var3= *value3*, ...]

Comparison:

This is a direct match on global strings.

You have the options of putting a "*" as a wildcard or using a PCRE style regular expression (must be wrapped in "/") to the value.

Examples:

If the HTTP_HOST is "www.example.org" this will match with:

[globalString = IENV:HTTP_HOST = www.example.org]

This will also match with it:

[globalString = IENV:HTTP_HOST = *example.org]

... but this will also match with an HTTP_HOST like this: "demo.example.org"

Important note on globalVar and globalString

You can use values from global arrays and objects by dividing the variable name with a "|" (vertical line).

Examples:

The global variable $HTTP_POST_VARS['key']['levels'] would be retrieved by "HTTP_POST_VARS|key|levels".

Also note that it's recommended to program your scripts in compliance with the php.ini-optimized settings. Please see that file (from your distribution) for details.

Caring about this means that you would get values like HTTP_HOST by getenv() and you would retrieve GET/POST values with TYPO3CMSCoreUtilityGeneralUtility::_GP(). Finally a lot of values from the TSFE object are useful. In order to get those values for comparison with "globalVar" and "globalString" conditions, you prefix that variable's name with either "IENV:"/"ENV:", "GP:", "TSFE:" or "LIT:" respectively. Still the "|" divider may be used to separate keys in arrays and/or objects. "LIT" means "literal" and the string after ":" is trimmed and returned as the value (without being divided by "|" or anything)

Note: Using the "IENV:" prefix is highly recommended to get server/environment variables which are system-independent. Basically this will get the value using TYPO3CMSCoreUtilityGeneralUtility::getIndpEnv(). With "ENV:" you get the raw output from getenv() which is not always the same on all systems!

Examples:

This will match with a remote address beginning with "192.168."

[globalString = IENV:REMOTE_ADDR = 192.168.*]

This will match with the frontend user whose username is "test":

[globalString = TSFE:fe_user|user|username = test]

Custom Conditions

(Since TYPO3 7.0) You can add own TypoScript conditions via a separate API.

Instead of using the "userFunc" condition, it is encouraged to use this new API for your own TypoScript conditions.

Syntax:

[YourVendor\YourPackage\YourCondition = var1 = value1, var2 != value2, ...]

Comparison:

An extension / package can ship an implementation of the abstract class AbstractCondition. Via the existing TypoScript condition syntax the class is called by the simple full namespaced class name.

The main function matchCondition of this class can then evaluate any parameters given after the class name. The parameters will be given in form of a numeric array, each entry containing the strings that are split by the commas, e.g. array('= var1 = value1', 'var2 != value2').

Examples:

This example shows how to write own TypoScript conditions and how to evaluate their parameters in PHP. With the PHP code following below, these three conditions will match:

[Documentation\Examples\TypoScript\ExampleCondition]
    Your TypoScript code here
[global]

[Documentation\Examples\TypoScript\ExampleCondition TYPO3]
    Your TypoScript code here
[global]

[Documentation\Examples\TypoScript\ExampleCondition = 42]
    Your TypoScript code here
[global]

<?php
namespace Documentation\Examples\TypoScript;

/**
 * Example condition
 */
class ExampleCondition extends \TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractCondition {

   /**
    * Evaluate condition
    *
    * @param array $conditionParameters
    * @return bool
    */
   public function matchCondition(array $conditionParameters) {
      $result = FALSE;
      if (empty($conditionParameters)) {
         $result = TRUE;
      }
      if (!empty($conditionParameters) && $conditionParameters[0] === 'TYPO3') {
         $result = TRUE;
      }
      if (!empty($conditionParameters) && substr($conditionParameters[0], 0, 1) === '=') {
         $conditionParameters[0] = trim(substr($conditionParameters[0], 1));
         if ($conditionParameters[0] = '42') {
            $result = TRUE;
         }
      }

      return $result;
   }
}

userFunc

Syntax:

[userFunc = user_function(argument1, argument2, ...)]

Comparison:

This calls a user-defined function (above called "user_function") and passes the provided parameters to that function (e.g. the two parameters "argument1" and "argument2"). Parameters can be enclosed with quotes so that leading and trailing spaces and commas inside a parameter can be used. Quotes can be escaped using the "" character. You write the function; you decide what it checks. The function should return true or false. Otherwise the result is evaluated to true or false.

Examples:

Put the following condition in your TypoScript:

[userFunc = Vendor\Extension\Condition\MyCondition::match(checkLocalIP, 192.168)]

It will call the class Vendor\\Extension\\Condition\\MyCondition with the function match, 'checkLocalIP' as first argument and '192.168' as second argument. The condition evaluates to true or false according to the result of the function.

Put this function in your MyCondition.php file:

class MyCondition {
   public static function user_match($command, $subnet) {
      switch($command) {
         case 'checkLocalIP':
            if (strstr(getenv('REMOTE_ADDR'), $subnet)) {
               return true;
            }
            break;
         case 'checkSomethingElse':
            // ....
            break;
      }
       return false;
   }
}

If the remote address contains "192.168", the condition will return true, otherwise it will return false.

The function in the following condition shows how quotes can be used. It has three arguments:

[userFunc = Vendor\Extension\Condition\MyCondition::testFunctionWithThreeArgumentsSpaces(1, 2, " 3, 4, 5, 6")]

The function in the next condition also has three arguments and it shows how quotes can be escaped:

[userFunc = Vendor\Extension\Condition\MyCondition::testFunctionWithThreeArgumentsEscapedQuotes(1, 2, "3, \"4, 5\", 6")]