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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer