Notice: You are browsing the documentation for PrestaShop 8, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 1.7.

Comparison between Classic and New translation systems

Module developers might be confused by both the Classic and New translation systems coexisting together. This page aims to help you choose the best one for your module.

What translation system is best for my module?

The best translation system for your module depends on two factors:

  • The minimum version of PrestaShop you intend to support:
    If you target 1.7.5 or earlier, you need to use the Classic system.
  • Whether your module uses Symfony controllers / Twig:
    If your module features Symfony controllers or uses Twig, you need to use the New system.

If you target 1.7.6 or 1.7.7, you can choose one or the other. However, if you choose the New system, you will have to use Classic translation dictionaries (PHP-based).

Target Minimum Version
≤ 1.7.5 1.7.6 1.7.7 ≥ 1.7.8
Classic system Recommended system Yes Yes Yes
New system Not supported It depends * It depends * Recommended system

Legend:

= Recommended system

No = Not available

Yes = Available

* Yes = Available, but only PHP dictionaries are supported (no export)

Feature comparison

The chart below summarizes the differences between the two translation systems.

  Classic System New System
Available since < 1.7 1.7.6+
Translation interface File-oriented
(default interface)
Translation domain-oriented
(requires opt-in)
Wording contextualization / grouping File where the wording appears Translation domain
Automatic discovery of new wordings in module files ✔️ Yes ✔️ Yes
Custom translation storage PHP-based dictionaries
(stored within the module directory)
Database
Translation distribution PHP-based dictionaries • PHP-based dictionaries
• XLIFF files 1.7.8
Export formats PHP-based dictionaries XLIFF files 1.7.8
Export method Copy files from the module’s directory Download via export interface 1.7.8
Supported environments FO & BO FO & BO
Method to use in PHP l(...) trans(...)
Method to use in Smarty {l mod="modulename" ...} {l d="Modules.Modulename.Something" ...}
Method to use in Twig N/A trans(...)
Supported in legacy controllers ✔️ Yes ✔️ Yes
Supported in Symfony controllers ❌ No ✔️ Yes