Introduction
Kirby comes with built-in support for multi-language sites. Languages can be defined, added and switched right in the Panel.
Features
- Define any number of languages for your site.
- Add new languages from the Panel.
- Set a different default language from the Panel.
- Use custom language variables to define string translations, for example for buttons, forms, options.
- Define custom language URLs.
- RTL languages are supported too.
Enabling the multi-lang feature in the Panel
To allow your users to define and switch languages from the Panel, you first have to enable it in /site/config/config.php:
<?php
return [
'languages' => true,
];Adding languages
The first language must always be defined as the default language. Make sure to only define one default language.
If your site already has content, make sure to set your first language to the language of this content.
Manually
New language definitions are created in the /site/languages folder. To add a new language, create a new PHP file with a filename consisting of the language code of the new language and the extension .php.
For example, to add English as a new language:
<?php
return [
'code' => 'en',
'default' => true,
'direction' => 'ltr',
'locale' => 'en_US',
'name' => 'English',
];Repeat for every new language you want to use.
If you encounter issues with functions like strftime that depend on the locale setting, you might have to add a suffix to the locale code that specifies the encoding format. Depending on your operating system and setup, try adding e.g. .utf-8 to your locale codes. Some operating systems however use different notations such as .UTF-8 or .UTF8.
You can list all available locales on your system by typing locale -a on the command line.
If you don't use the Panel, you have to add the language extension to your text files manually. The language extension is mandatory, otherwise Kirby will not work as expected.
Via the Panel
After enabling languages in your config as described above, you can find the language setup on the Panel in the "Language" view.
The languages view is only visible in the menu when you switch to a multi-language setup. It features the same language editor from previous versions.
To add the first/a new language, click on "Add a new language" and add the language name, code, direction and PHP locale string.
Once the default language is defined, you can add more languages as secondary languages. The Panel automatically renames all existing content and file meta data files and includes the language extension.
Manage languages in the Panel
The Panel offers options to delete and edit a language. You can access them by clicking on the menu icon (three dots):
Edit: Change the name, locale or reading direction of the language.
Delete: Delete the language.
If you delete a language, all of its content files are deleted. This can even result in all your content being deleted if you delete the wrong language.
Language specific URLs
By default, the URL of your site changes and the language code is added to the URL. If you want to keep the root URL for the default language, you can set the URL manually using the url option:
<?php
return [
'code' => 'en',
'default' => true,
'direction' => 'ltr',
'locale' => [
'LC_ALL' => 'en_GB'
],
'name' => 'English',
'translations' => [
],
'url' => '/'
];Using the root URL for the default language will disable automatic language detection.
Using different domains for each language
Kirby supports cross-domain multi-language sites. You can define the domain for each language like this:
<?php
return [
'code' => 'en',
'default' => true,
'direction' => 'ltr',
'locale' => 'en_US',
'name' => 'English',
'url' => 'https://example.com'
];<?php
return [
'code' => 'de',
'default' => false,
'direction' => 'ltr',
'locale' => 'de_DE',
'name' => 'Deutsch',
'url' => 'https://example.de'
];Make sure that both domains point to your Kirby site.
Detailed locale settings
If you need more control over your locale settings for each language, you can pass an array of locales:
<?php
return [
'code' => 'en',
'default' => true,
'direction' => 'ltr',
'name' => 'English',
'url' => '/',
'locale' => [
LC_ALL => 'en_US.utf8',
LC_COLLATE => 'en_US.utf8',
LC_MONETARY => 'en_US.utf8',
LC_NUMERIC => 'en_US.utf8',
LC_TIME => 'en_US.utf8',
LC_MESSAGES => 'en_US.utf8',
LC_CTYPE => 'en_US.utf8'
]
];<?php
return [
'code' => 'de',
'default' => false,
'direction' => 'ltr',
'name' => 'Deutsch',
'url' => 'de',
'locale' => [
LC_ALL => 'de_DE.utf8',
LC_COLLATE => 'de_DE.utf8',
LC_MONETARY => 'de_DE.utf8',
LC_NUMERIC => 'de_DE.utf8',
LC_TIME => 'de_DE.utf8',
LC_MESSAGES => 'de_DE.utf8',
LC_CTYPE => 'de_DE.utf8'
]
];This is useful if specific locales need to be set to a different value.
The LC_ALL locale should always be set as it is used as a default locale internally in the Kirby core. Other locales can be set to override the default LC_ALL locale for specific use-cases.
Language specific date handlers
By default, Kirby uses PHP's date function to format dates for pages and files. date() does not respect locale settings and always creates English month and day names. You can switch to strftime() as your primary date handler, which uses a different format for dates, but also supports translated month and day names. To switch the handler, add the following to your config:
<?php
return [
'date.handler' => 'strftime',
];Automatic language detection
Kirby can detect the preferred language of the visitor. This has to be enabled in your config:
return [
'languages.detect' => true
]