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 NullPage nullGet the current language or optionally a specific named language 
Languages::getLocale()
string boolReturn the current locale setting 
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.137

Twitter updates

  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019
  • ProcessWire 3.0.143 core updates — 26 commits and 18 resolved issue reports, plus some other useful improvements and additions. More here: More
    25 October 2019

Latest news

  • ProcessWire Weekly #287
    In the 287th issue of ProcessWire Weekly we'll talk a bit about the latest core versions 3.0.144 and 3.0.145, introduce a third party module called Sanitizer EasySlugger, and publish a new #processwireworks poll. Read on!
    Weekly.pw / 9 November 2019
  • ProcessWire 3.0.145 core updates
    ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core.
    Blog / 8 November 2019
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani