Languages class

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.

Show class?             Show args?        

Common

NameReturnSummary 
Languages::default Language Get default language 
Languages::editable($language)
boolDoes current user have edit access for page fields in given language? 
Languages::findNonDefault()
PageArrayFind and return all languages except default language 
Languages::findOther()
PageArrayFind and return all languages except current user language 
Languages::getDefault()
LanguageGet the default language
Can also be used as property: Languages::getDefault
 
Languages::getLanguage()
Language nullGet the current language or optionally a specific named language 
Languages::getLocale()
string boolReturn the current locale setting 
Languages::hasPageNames()
boolIs LanguageSupportPageNames installed? 
Languages::importTranslationsFile($language, string $file)
bool intImport a language translations file 
Languages::pageNames()
LanguageSupportPageNames falseGet LanguageSupportPageNames module if installed, false if not 
Languages::setDefault()
(nothing)Set current user to have default language temporarily 
Languages::setLanguage($language)
boolSet the current user language for the current request 
Languages::setLocale()
string boolSet the current locale 
Languages::translator(Language $language)
LanguageTranslatorReturn the LanguageTranslator instance for the given language 
Languages::unsetDefault()
(nothing)Restores whatever previous language a user had prior to a setDefault() call 
Languages::unsetLanguage()
boolUndo a previous setLanguage() call, restoring the previous user language 

For hooks

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

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #543
    In the 543rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a couple of new third party modules — both authored by Bernhard Baumrock — and more. Read on!
    Weekly.pw / 5 October 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer