Locales // Statamic 3 Docs

Overview

This tag is used to access all the locales any given entry or term is available in. It’s most commonly used as a language switcher.

Each locale’s system data, as configured in config/statamic/sites.php, is available inside of a locale array.

Examples

Iterating over locales

Loop through in each locale to get URLs to translated versions of an entry or taxonomy term.

<ul>
{{ locales }}
    <li><a href="{{ permalink }}">View in {{ locale:name }}</a></li>
{{ /locales }}
</ul>

Targeting a locale

You can also specify a locale directly instead of looping through them all.

{{ locales:fr }}
    <a href="{{ permalink }}">View in French</a>
{{ /locales:fr }}

Excluding the current locale

You can choose to not show the current locale in a list.

{{ locales }}
  {{ if ! is_current }}
    <a href="{{ permalink }}">View in {{ locale:name }}</a>
  {{ /if }}
{{ /locales }}

Parameters

id string

The ID of the content you want to localize. If left blank, the content will be taken from the context.

sort string

Sort by one of the keys in your sites.php's sites array. (eg. name or full). If left blank, the order in the file will be maintained. Only applicable in the tag pair.

current_first boolean true

When true, this ensures that the current site locale will be first in the list. Only applicable in the tag pair.

Variables

Variable	Type	Description
current	`string`	The `handle` of the current locale.
locale:[key/handle]	`string`	The system handle for any given locale as set in `config/statamic/sites.php`.
locale:name	`string`	The user-friendly name for any given locale as set in `config/statamic/sites.php`.
locale:full	`string`	The full, 4 character system locale (e.g. `en_US`) for any given locale as set in `config/statamic/sites.php`.
locale:short	`string`	The short 2 character system locale (e.g. `en`) for any given locale as set in `config/statamic/sites.php`.
locale:is_current	`boolean`	`true` if the given locale in the loop is the current one.