You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.
Internationalization and localization adapt the applications and their contents
to the specific region or language of the users. In Symfony this is an opt-in
feature that needs to be installed before using it (
composer require translation).
Translation Source File Location¶
Store the translation files in the
translations/ directory at the root
of your project.
Your translators' lives will be much easier if all the application translations are in one central location.
Translation Source File Format¶
The Symfony Translation component supports lots of different translation
formats: PHP, Qt,
.mo, JSON, CSV, INI, etc.
Use the XLIFF format for your translation files.
Of all the available translation formats, only XLIFF and gettext have broad support in the tools used by professional translators. And since it's based on XML, you can validate XLIFF file contents as you write them.
Symfony supports notes in XLIFF files, making them more user-friendly for translators. At the end, good translations are all about context, and these XLIFF notes allow you to define that context.
The Apache-licensed JMSTranslationBundle offers you a web interface for viewing and editing these translation files. It also has advanced extractors that can read your project and automatically update the XLIFF files.
Always use keys for translations instead of content strings.
Using keys simplifies the management of the translation files because you can change the original contents without having to update all of the translation files.
Keys should always describe their purpose and not their location. For
example, if a form has a field with the label "Username", then a nice key
Example Translation File¶
Applying all the previous best practices, the sample translation file for English in the application would be:
1 2 3 4 5 6 7 8 9 10 11 12
<!-- translations/messages.en.xlf --> <?xml version="1.0"?> <xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2"> <file source-language="en" target-language="en" datatype="plaintext" original="file.ext"> <body> <trans-unit id="title_post_list"> <source>title.post_list</source> <target>Post List</target> </trans-unit> </body> </file> </xliff>
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.