Attention
TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.
Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v11 here: TYPO3 ELTS.
Security.ifHasRole ViewHelper <f:security.ifHasRole>
This ViewHelper implements an ifHasRole/else condition for frontend groups.
Examples
Basic usage
<f:security.ifHasRole role="Administrator">
This is being shown in case the current FE user belongs to a FE usergroup (aka role) titled "Administrator" (case sensitive)
</f:security.ifHasRole>
Everything inside the <f:
tag is being displayed if the
logged in frontend user belongs to the specified frontend user group.
Comparison is done by comparing to title of the user groups.
Using the usergroup uid as role identifier
<f:security.ifHasRole role="1">
This is being shown in case the current FE user belongs to a FE usergroup (aka role) with the uid "1"
</f:security.ifHasRole>
Everything inside the <f:
tag is being displayed if the
logged in frontend user belongs to the specified role. Comparison is done
using the uid
of frontend user groups.
IfRole / then / else
<f:security.ifHasRole role="Administrator">
<f:then>
This is being shown in case you have the role.
</f:then>
<f:else>
This is being displayed in case you do not have the role.
</f:else>
</f:security.ifHasRole>
Everything inside the <f:
tag is displayed if the logged in FE user belongs to the specified role.
Otherwise, everything inside the <f:
tag is displayed.
Source code
Go to the source code of this ViewHelper: IfHasRoleViewHelper.php (GitHub).
Arguments
The following arguments are available for <f:
:
then
-
- Type
- mixed
Value to be returned if the condition if met.
else
-
- Type
- mixed
Value to be returned if the condition if not met.
role
-
- Type
- string
The usergroup (either the usergroup uid or its title).