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::importTranslationsFile($language, string $file)
bool intImport a language translations file 
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.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH