Making Eloquent models translatable

License: MIT

Language: PHP

Keywords: eloquent, i18n, laravel, php, translated-attributes

A trait to make Eloquent models translatable

Latest Version on Packagist MIT Licensed Build Status Quality Score StyleCI Total Downloads

This package contains a trait to make Eloquent models translatable. Translations are stored as json. There is no extra table needed to hold them.

Once the trait is installed on the model you can do these things:

$newsItem = new NewsItem; // This is an Eloquent model
   ->setTranslation('name', 'en', 'Name in English')
   ->setTranslation('name', 'nl', 'Naam in het Nederlands')
$newsItem->name; // Returns 'Name in English' given that the current app locale is 'en'
$newsItem->getTranslation('name', 'nl'); // returns 'Naam in het Nederlands'


$newsItem->name; // Returns 'Naam in het Nederlands'


You can install the package via composer:

composer require spatie/laravel-translatable

If you want to have another fallback_locale then the app fallback locale (see config/app.php), you could publish the config file:

php artisan vendor:publish --provider="Spatie\Translatable\TranslatableServiceProvider"

This is the contents of the published file:

return [
  'fallback_locale' => 'en',

Making a model translatable

The required steps to make a model translatable are:

  • First, you need to add the Spatie\Translatable\HasTranslations-trait.
  • Next, you should create a public property $translatable which holds an array with all the names of attributes you wish to make translatable.
  • Finally, you should make sure that all translatable attributes are set to the text-datatype in your database. If your database supports json-columns, use that.

Here's an example of a prepared model:

use Illuminate\Database\Eloquent\Model;
use Spatie\Translatable\HasTranslations;

class NewsItem extends Model
    use HasTranslations;
    public $translatable = ['name'];

Available methods

Getting a translation

The easiest way to get a translation for the current locale is to just get the property for the translated attribute. For example (given that name is a translatable attribute):


You can also use this method:

public function getTranslation(string $attributeName, string $locale) : string

This function has an alias named translate.

Getting all translations

You can get all translations by calling getTranslations() without an argument:


Or you can use the accessor


Setting a translation

The easiest way to set a translation for the current locale is to just set the property for a translatable attribute. For example (given that name is a translatable attribute):

$newsItem->name = 'New translation';

To set a translation for a specific locale you can use this method:

public function setTranslation(string $attributeName, string $locale, string $value)

To actually save the translation, don't forget to save your model.

$newsItem->setTranslation('name', 'en', 'Updated name in English');



  • if you want to validate an attribute for uniqueness before saving/updating the db, you might want to have a look at laravel-unique-translation which is made specifically for laravel-translatable.

Forgetting a translation

You can forget a translation for a specific field:

public function forgetTranslation(string $attributeName, string $locale)

You can forget all translations for a specific locale:

public function forgetAllTranslations(string $locale)

Getting all translations in one go

public function getTranslations(string $attributeName): array

Setting translations in one go

public function setTranslations(string $attributeName, array $translations)

Here's an example:

$translations = [
   'en' => 'Name in English',
   'nl' => 'Naam in het Nederlands'

$newsItem->setTranslations('name', $translations);



Right after calling setTranslation the Spatie\Translatable\Events\TranslationHasBeenSet-event will be fired.

It has these properties:

/** @var \Illuminate\Database\Eloquent\Model */
public $model;

/** @var string  */
public $attributeName;

/** @var string  */
public $locale;

public $oldValue;
public $newValue;

Creating models

You can immediately set translations when creating a model. Here's an example:

   'name' => [
      'en' => 'Name in English',
      'nl' => 'Naam in het Nederlands'

Querying translatable attributes

If you're using MySQL 5.7 or above, it's recommended that you use the json data type for housing translations in the db. This will allow you to query these columns like this:

NewsItem::where('name->en', 'Name in English')->get();


Please see CHANGELOG for more information what has changed recently.


From v2 to v3

In most cases you can upgrade without making any changes to your codebase at all. v3 introduced a translations accessor on your models. If you already had one defined on your model, you'll need to rename it.


composer test


Please see CONTRIBUTING for details.


If you discover any security related issues, please email instead of using the issue tracker.


You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.


We got the idea to store translations as json in a column from Mohamed Said. Parts of the readme of his multilingual package were used in this readme.

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.


The MIT License (MIT). Please see License File for more information.

Project Statistics

Sourcerank 15
Repository Size 125 KB
Stars 839
Forks 110
Watchers 15
Open issues 3
Dependencies 6
Contributors 33
Tags 30
Last updated
Last pushed

Top Contributors See all

Freek Van der Herten Sebastian De Deyne Rick van der Burg Cormoran Nate Ritter Muah Roy Duineveld Damir Miladinov Cristian Tabacitu Timon de Groot JolitaGrazyte Ron Melkhior Vince Mitchell Paolo Caleffi Gert de Pagter Florian Robbert tontonsb robinmartini Gabriel Caruso

Packages Referencing this Repo

A trait to make an Eloquent model hold translations
Latest release 4.1.4 - Updated - 839 stars

Recent Tags See all

4.1.4 August 29, 2019
4.1.3 July 16, 2019
4.1.2 June 05, 2019
4.1.1 February 27, 2019
4.1.0 February 27, 2019
4.0.0 February 27, 2019
3.1.3 February 27, 2019
3.1.2 February 05, 2019
3.1.1 December 19, 2018
3.1.0 November 29, 2018
3.0.1 October 17, 2018
3.0.0 October 16, 2018
2.2.1 August 24, 2018
2.2.0 March 10, 2018
2.1.5 February 28, 2018

Interesting Forks See all

Making Eloquent models translatable
PHP - Updated - 3 stars
Making Eloquent models translatable
PHP - MIT - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-08-29 18:34:05 UTC

Login to resync this repository