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::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.200

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #425
    In the 425th issue of ProcessWire Weekly we'll cover a new blog post from Ryan, introduce the Minify Page Render module, and more. Read on!
    Weekly.pw / 2 July 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer