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, using PHP sprintf() notation in the
language file:
<trans-unit id="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
.
As in PHP's sprintf
you can order placeholders (Second %2$s, first %1$s
)
or use specific types like A padded number: %'.
, returning 000000123
for a number
passed as 123
.
See the sprintf PHP Documentation for more information on possible formatting.
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 the translate ViewHelper:
arguments
-
- Type
- array
Arguments to be replaced in the resulting string
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
extensionName
-
- Type
- string
UpperCamelCased extension key (for example BlogExample)
id
-
- Type
- string
Translation ID. Same as key.
key
-
- Type
- string
Translation Key
languageKey
-
- Type
- string
Language key ("da" for example) or "default" to use. Also a Locale object is possible. If empty, use current locale from the request.