Skip to content

Back Office translations

Changing Back Office languages

Installing new translations

If you want to install a new language in your project, install the corresponding package.

For example, if you want to translate your application into French, run:

composer require ezplatform-i18n/ezplatform-i18n-fr_fr

and then clear the cache.

Now you can reload your eZ Platform Back Office. If your browser language is set to French, the Back Office will be displayed in French.

Checking browser language

To make sure that a language is set in your browser, check if it is sent as an accepted language in the Accept-Language header.

Tip

If you do not want to add a bundle with Back Office translation, you can manually add the necessary .xliff files. Add the language to an array under ezpublish.system.<siteaccess>.user_preferences.additional_translations, for example:

ezpublish.system.<siteaccess>.user_preferences.additional_translations: ['pl_PL', 'fr_FR']

Then, run composer run post-update-cmd and clear the cache.

Contributing Back Office translations

To learn how to contribute to a translation, see Contributing translations.

Selecting Back Office language

Once you have language packages installed, you can switch the language of the Back Office in the User Settings menu.

Otherwise, the language will be selected based on the browser language. If you do not have a language defined in the browser, the language will be selected based on parameters.locale_fallback in default_parameters.yml.

Custom string translations

When you extend the Back Office you often need to provide labels for new elements. It is good practice to provide your labels in translations files, instead of literally, so they can be reused and translated into other languages.

To provide label strings, make use of the Symfony\Component\Translation\TranslatorInterface and its trans() method.

The method takes as arguments:

  • id of the message you want to translate
  • an array of parameters
  • domain of the string

Here's an example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
use Symfony\Component\Translation\TranslatorInterface;

private $translator;

public function __construct(TranslatorInterface $translator)
{
    $this->translator = $translator;
}

private function getTranslatedDescription(): string
{
    return $this->translator->trans(
        'custom.extension.description',
        [],
        'custom_extension'
    );
}

The strings are provided in .xliff files. The file should be stored in your project's or your bundle's Resources/translations folder.

File name corresponds to the selected domain and the language, e.g. custom_extension.en.xliff.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:jms="urn:jms:translation" version="1.2">
    <file source-language="en" target-language="en" datatype="plaintext" original="not.available">
        <header>
            <tool tool-id="JMSTranslationBundle" tool-name="JMSTranslationBundle" tool-version="1.1.0-DEV"/>
            <note>The source node in most cases contains the sample message as written by the developer. If it looks like a dot-delimitted string such as "form.label.firstname", then the developer has not provided a default message.</note>
        </header>
        <body>
            <trans-unit id="1ea2690f8ebd8fc946f92cf94ac56b8b93e46afe" resname="custom.extension.description">
                <source>My custom label</source>
                <target state="new">My custom label</target>
                <note>key: custom.extension.description</note>
            </trans-unit>
        </body>
    </file>
</xliff>

To provide a translation into another language, add it in the <target> tag. For example, in custom_extension.de.xliff:

1
2
3
4
5
<trans-unit id="1ea2690f8ebd8fc946f92cf94ac56b8b93e46afe" resname="custom.extension.description">
    <source>My custom label</source>
    <target state="new">Meine benutzerdefinierte Bezeichnung</target>
    <note>key: custom.extension.description</note>
</trans-unit>

The language to display will then be selected automatically based on user preferences or browser setup.

Note

You may need to clear the cache after adding new translations, before they are available in the Back Office.

Read the Docs