Attention

TYPO3 v10 has reached end-of-life as of April 30th 2023 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 v10 here: TYPO3 ELTS.

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:security.ifHasRole> 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:security.ifHasRole> 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:then></f:then> tag is displayed if the logged in FE user belongs to the specified role. Otherwise, everything inside the <f:else></f:else> tag is displayed.

Arguments

then

DataType

mixed

Required

false

Description

Value to be returned if the condition if met.

else

DataType

mixed

Required

false

Description

Value to be returned if the condition if not met.

role

DataType

string

Required

false

Description

The usergroup (either the usergroup uid or its title).