API variable $languages enables access to all Language pages and various helper methods.

The $languages API variable is most commonly used for iteration of all installed languages.

foreach($languages as $language) {
  echo "<li>$language->title ($language->name) ";
  if($language->id == $user->language->id) {
    echo "current"; // the user's current language
  echo "</li>";

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Languages class also inherits all the methods and properties of: PagesType and Wire.

Common / For hooks


Name Return Summary  
Languages::default Language Get default language
Languages::editable($language) bool Does current user have edit access for page fields in given language?
Languages::findNonDefault() PageArray Find and return all languages except default language
Languages::findOther() PageArray Find and return all languages except current user language
Languages::getDefault() Language Get the default language
Can also be used as property: Languages::getDefault
Languages::setDefault() (nothing) Set current user to have default language temporarily
Languages::setLanguage($language) bool Set the current user language for the current request
Languages::translator(Language $language) LanguageTranslator Return the LanguageTranslator instance for the given language
Languages::unsetDefault() (nothing) Restores whatever previous language a user had prior to a setDefault() call
Languages::unsetLanguage() bool Undo a previous setLanguage() call, restoring the previous user language

For hooks

This methods are only useful for hooking and should not be called directly.

Name Return Summary  
Languages::added(Page $language) (nothing) Hook called when a language is added
Languages::deleted(Page $language) (nothing) Hook called when a language is deleted
Languages::updated(Page $language, string $what) (nothing) Hook called when a language is added or deleted

Additional methods and properties

In addition to the methods and properties above, Languages also inherits the methods and properties of these classes: