Skip to main content
Version: 2026.2

Localized Fields

Localized fields allow the definition of attributes, that should be translated into multiple languages within an object. They can be filled with selected data types and layouts - due to technical and data storage reasons not all data types are available.

This simplifies translation of fields to the configured languages.

Definition of localized fields​

Configure localized fields and layouts within your class using the class editor.

Add localized fields to a classAdd localized fields to a classAdd localized fields to a class

Then add attributes, that need to be translated, into this container as any other attributes. Note, that not all field types are supported for localized fields.

In the editor, the localized fields are displayed as normal fields with a language indication in the label. Language switch is possible via the global language switcher in the bottom toolbar of the editor.

Localized page previewLocalized page previewLocalized page preview

Definition of available Languages​

Specify the valid languages for your website in System -> System Settings -> Localization & Internationalization if not already configured.

Definition of required Languages​

If you want to have mandatory fields in the localized fields, but they are not mandatory for all languages, you can define which languages are required in System -> System Settings -> Localization & Internationalization with the Mandatory language checkbox on each language.

Inheritance​

Fallback and inherited values are evaluated in a vertical way first. This is contrary to the Classification Store where the evaluation is done in a horizontal way. If no value for the current language is found, the parent level is checked.

If walking up the inheritance levels yields no result, the fallback language of the lowermost level will be checked in the same way. (Also walking up the inheritance levels for this language).

Consider the following example, assuming English is the fallback language for German. We request the German value for the object at level 3. Since the only value can be found on level 1 for the default language the tree is traversed as depicted.

Language value levels in Localized FieldsLanguage value levels in Localized FieldsLanguage value levels in Localized Fields

Working with PHP API​

Getting available languages​

The following code will create an array containing the available languages for the front end (the user facing website).

$languages = \Pimcore\Tool::getValidLanguages();

Disable Fallback languages​

You can disable the Fallback languages

\Pimcore\Model\DataObject\Localizedfield::setGetFallbackValues(false);

Accessing the data​

Access the data as follows:

// with global registered locale
$object = DataObject::getById(234);
$object->getInput1(); // will return the en_US data for the field "input1"
 
 
// get specific localized data, regardless which locale is globally registered
$object->getInput1("de"); // will return the German value for the field "input1"

Setting data​

Setting data works the same way:

$object = DataObject::getById(234);
$object->setInput1("My Name", "fr"); // set the French value for the field "input1"

Warning: Moving a field from outside (normal object field) into the localizedfield container causes data loss for that field in all objects using this class.