1.5
Core concepts
Customization
Troubleshooting
Multilanguage
Voyager supports multiple languages for your models.To get started, you need to configure some things first.
Setup
First you need to define some
locales in your config/voyager.php file and enable multilanguage:1
'multilingual' => [
2
'enabled' => true,
3
'default' => 'en',
4
'locales' => [
5
'en',
6
'da',
7
],
8
],
Copied!
After that you need to include the
Translatable Trait in your model and define the translatable attributes:1
use TCG\Voyager\Traits\Translatable;
2
class Post extends Model
3
{
4
use Translatable;
5
protected $translatable = ['title', 'body'];
6
}
Copied!
Now you will see a language-selection in your Pages BREAD.
Usage
Eager-load translations
1
// Loads all translations
2
$posts = Post::with('translations')->get();
3
​
4
// Loads all translations
5
$posts = Post::all();
6
$posts->load('translations');
7
​
8
// Loads all translations
9
$posts = Post::withTranslations()->get();
10
​
11
// Loads specific locales translations
12
$posts = Post::withTranslations(['en', 'da'])->get();
13
​
14
// Loads specific locale translations
15
$posts = Post::withTranslation('da')->get();
16
​
17
// Loads current locale translations
18
$posts = Post::withTranslation('da')->get();
Copied!
Get default language value
1
echo $post->title;
Copied!
Get translated value
1
echo $post->getTranslatedAttribute('title', 'locale', 'fallbackLocale');
Copied!
If you do not define locale, the current application locale will be used. You can pass in your own locale as a string. If you do not define fallbackLocale, the current application fallback locale will be used. You can pass your own locale as a string. If you want to turn the fallback locale off, pass false. If no values are found for the model for a specific attribute, either for the locale or the fallback, it will set that attribute to null.
Translate the whole model
1
$post = $post->translate('locale', 'fallbackLocale');
2
echo $post->title;
3
echo $post->body;
4
​
5
// You can also run the `translate` method on the Eloquent collection
6
// to translate all models in the collection.
7
$posts = $posts->translate('locale', 'fallbackLocale');
8
echo $posts[0]->title;
Copied!
If you do not define locale, the current application locale will be used. You can pass in your own locale as a string. If you do not define fallbackLocale, the current application fallback locale will be used. You can pass in your own locale as a string. If you want to turn the fallback locale off, pass false. If no values are found for the model for a specific attribute, either for the locale or the fallback, it will set that attribute to null.
Check if model is translatable
1
// with string
2
if (Voyager::translatable(Post::class)) {
3
// it's translatable
4
}
5
​
6
// with object of Model or Collection
7
if (Voyager::translatable($post)) {
8
// it's translatable
9
}
Copied!
Set attribute translations
1
$post = $post->translate('da');
2
$post->title = 'foobar';
3
$post->save();
Copied!
This will update or create the translation for title of the post with the locale da. Please note that if a modified attribute is not translatable, then it will make the changes directly to the model itself. Meaning that it will overwrite the attribute in the language set as default.
Query translatable Models
To search for a translated value, you can use the
whereTranslation method.
For example, to search for the slug of a post, you'd use1
$page = Page::whereTranslation('slug', 'my-translated-slug');
2
// Is the same as
3
$page = Page::whereTranslation('slug', '=', 'my-translated-slug');
4
// Search only locale en, de and the default locale
5
$page = Page::whereTranslation('slug', '=', 'my-translated-slug', ['en', 'de']);
6
// Search only locale en and de
7
$page = Page::whereTranslation('slug', '=', 'my-translated-slug', ['en', 'de'], false);
Copied!
whereTranslation accepts the following parameter:fieldthe field you want to search invaluethe value you want to search forlocalesthe locales you want to search in as an array. Leave asnullif you want to search all localesdefaultalso search in the default value/locale. Defaults to true.
Last modified 1mo ago