Translate ViewHelper <f:translate>

ViewHelper to provide a translation for language keys ("locallang"/"LLL"). By default, the files are loaded from the folder Resources/Private/Language/. Placeholder substitution (like PHP's sprintf()) can be evaluated when provided as arguments attribute.

Go to the source code of this ViewHelper: TranslateViewHelper.php (GitHub).

Table of contents

Examples

Short key - Usage in Extbase

The key argument alone works only within the Extbase context.

<f:translate key="domain_model.title" />
Copied!
packages/my_extension/Resources/Private/Language/locallang.xlf 
<?xml version="1.0" encoding="UTF-8" ?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
	<file source-language="en" datatype="plaintext"
		original="EXT:my_extension/Resources/Private/Language/locallang.xlf"
		date="2020-10-18T18:20:51Z" product-name="my_extension"
	>
		<header />
		<body>
			<trans-unit id="domain_model.title">
				<source>My Model</source>
			</trans-unit>
		</body>
	</file>
</xliff>
Copied!

Alternatively, you can use id instead of key, producing the same output. If both id and key are set, id takes precedence.

If the translate ViewHelper is used with only the language key, the template must be rendered within an Extbase request, usually from an Extbase controller action. The default language file must be located in the same extension as the Extbase controller and must be saved in the file Resources/Private/Language/locallang.xlf.

Short key and extension name

When the ViewHelper is called from outside Extbase, it is mandatory to either pass the extension name or use the full LLL: reference for the key.

<f:translate key="domain_model.title" extension="my_extension" />
Copied!

The default language file must be saved in the extension specified in the argument, in the file Resources/Private/Language/locallang.xlf.

Full LLL: reference key

Using the LLL: language reference syntax, a language key from any .xlf file can be used.

<f:translate
    key="LLL:EXT:my_extension/Resources/Private/Language/my_locallang.xlf:domain_model.title"
/>
Copied!

Keeping HTML tags within translations

HTML in language labels can be used when you surround the translate ViewHelper with a ViewHelper that allows HTML output, such as the Sanitize.html ViewHelper <f:sanitize.html> in the backend or the Format.html ViewHelper <f:format.html> in the frontend.

<f:format.html>
    <f:translate
        key="LLL:EXT:my_extension/Resources/Private/Language/my_locallang.xlf:myKey"
    />
</f:format.html>
Copied!
packages/my_extension/Resources/Private/Language/locallang.xlf 
<?xml version="1.0" encoding="UTF-8" ?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
	<file source-language="en" datatype="plaintext"
		original="EXT:my_extension/Resources/Private/Language/locallang.xlf"
		date="2020-10-18T18:20:51Z" product-name="my_extension"
	>
		<header />
		<body>
			<trans-unit id="myKey">
				<source>
                    <![CDATA[By default, ordered and unordered lists are formatted
                    with bullets and decimals. <br>
                    By adding <code>class="list-unstyled"</code> to the ol or ul tag, it
                    is possible to structure content in list form without the
                    typical list styling.]]>
				</source>
			</trans-unit>
		</body>
	</file>
</xliff>
Copied!

The entry in the .xlf language file must be surrounded by <![CDATA[...]]>.

Displaying translated labels with placeholders

<f:translate
    key="LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:domain_model.title"
    arguments="{0: '{myVariable}'}"
/>

Or with several numbered placeholders:

<f:translate
    key="LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:domain_model.title"
    arguments="{1: '{myVariable}', 2: 'Some String'}"
/>
Copied! 
<?xml version="1.0" encoding="UTF-8" ?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
	<file source-language="en" datatype="plaintext"
		original="EXT:my_extension/Resources/Private/Language/locallang.xlf"
		date="2020-10-18T18:20:51Z" product-name="my_extension"
	>
		<header />
		<body>
			<label index="domain_model.title">Title of: %s</label>
			<trans-unit id="domain_model.description">
				<source>Some text about a %1$s and a %2$s.</source>
			</trans-unit>
		</body>
	</file>
</xliff>
Copied!

The placeholder %s is used to insert dynamic values, passed as the parameter arguments to the translate ViewHelper. If %s appears multiple times, it references subsequent array entries in order.

To avoid dependency on order, use indexed placeholders like %1$s. This explicitly refers to the first value and ensures that it is treated as a string ($s). This method is based on PHP’s vsprintf function <https://www.php.net/manual/en/function.vsprintf.php>, which allows for more flexible and readable formatting.

Inline notation with arguments and default value

Like all other ViewHelpers, the translate ViewHelper can be used with the Inline syntax.

{f:translate(key: 'someKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
Copied!

This is especially useful if you want to pass the translated label to another ViewHelper, for example, as the alt parameter of an image:

<f:image src="EXT:my_extension/Resources/Public/icons/Edit.svg"
    alt="{f:translate(key: 'icons.edit', default: 'Edit')}"
/>
Copied!

The translation ViewHelper in console/CLI context

The translation ViewHelper determines the target language based on the current frontend or backend request.

If you are rendering your template from a console/CLI context, for example, when you Send emails with FluidEmail, use the argument languageKey to specify the desired language for the ViewHelper:

Salutation in Danish:
<f:translate
    key="LLL:EXT:my_extension/Resources/Private/Language/my_locallang.xlf:salutation"
    languageKey="da"
/>

Salutation in English:
<f:translate
    key="LLL:EXT:my_extension/Resources/Private/Language/my_locallang.xlf:salutation"
    languageKey="default"
/>
Copied!

Arguments of the f:translate ViewHelper

arguments

arguments
Type
array
Arguments to be replaced in the resulting string

default

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

extensionName
Type
string
UpperCamelCased extension key (for example BlogExample)

id

id
Type
string
Translation ID. Same as key.

key

key
Type
string
Translation Key

languageKey

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.