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.
Translate ViewHelper <f:translate>
Translate a key from locallang. The files are loaded from the folder
Resources/
.
Examples
Translate key
<f:translate key="key1" />
Value of key key1
in the current website language. Alternatively id can
be used instead of key:
<f:translate id="key1" />
This will output the same as above. If both id and key are set, id will take precedence.
Keep HTML tags
<f:format.raw><f:translate key="htmlKey" /></f:format.raw>
Value of key htmlKey
in the current website language, no htmlspecialchars
applied.
Translate key from custom locallang file
<f:translate key="key1" extensionName="MyExt"/>
or
<f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" />
Value of key key1
in the current website language.
Inline notation with arguments and default value
{f:translate(key: 'someKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
Value of key someKey
in the current website language
with the given arguments (dog and fox) assigned for the specified
%s
conversions (sprintf
) in the language file:
<trans-unit id="someKey" resname="someKey">
<source>Some text about a %s and a %s.</source>
</trans-unit>
The output will be "Some text about a dog and a fox".
If the key someKey
is not found in the language file, the output is default value.
Inline notation with extension name
{f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
Value of key someKey
in the current website language.
The locallang file of extension "some_extension_name" will be used.
Source code
Go to the source code of this ViewHelper: TranslateViewHelper.php (GitHub).
Arguments
The following arguments are available for <f:
:
key
-
- Type
- string
Translation Key
id
-
- Type
- string
Translation ID. Same as key.
default
-
- Type
- string
If the given locallang key could not be found, this value is used. If this argument is not set, child nodes will be used to render the default
arguments
-
- Type
- mixed
Arguments to be replaced in the resulting string
extensionName
-
- Type
- string
UpperCamelCased extension key (for example BlogExample)
languageKey
-
- Type
- string
Language key ("dk" for example) or "default" to use for this translation. If this argument is empty, we use the current language
alternativeLanguageKeys
-
- Type
- mixed
Alternative language keys if no translation does exist