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?       Only hookable?    

Common

NameReturnSummary 
Languages::editable($language)
bool

Does current user have edit access for page fields in given language?

 
Languages::findNonDefault()
PageArray

Find and return all languages except default language

 
Languages::findOther()
PageArray

Find and return all languages except current user language

 
Languages::getDefault()
Language

Get the default language


Can also be used as property: Languages::getDefault 		 
Languages::getLanguage()
Language null

Get the current language or optionally a specific named language

 
Languages::getLocale()
string bool

Return the current locale setting

 
Languages::hasPageNames()
bool

Is LanguageSupportPageNames installed?

 
Languages::importTranslationsFile($language, string $file)
bool int

Import a language translations file

 
Languages::pageNames()
LanguageSupportPageNames false

Get LanguageSupportPageNames module if installed, false if not

 
Languages::setDefault()
None

Set current user to have default language temporarily

 
Languages::setLanguage($language)
bool

Set the current user language for the current request

 
Languages::setLocale()
string bool

Set the current locale

 
Languages::translator(Language $language)
LanguageTranslator

Return the LanguageTranslator instance for the given language

 
Languages::unsetDefault()
None

Restores whatever previous language a user had prior to a setDefault() call

 
Languages::unsetLanguage()
bool

Undo a previous setLanguage() call, restoring the previous user language

 

For hooks

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

NameReturnSummary 
Languages::added(Page $language)
None

Hook called when a language is added

Languages::deleted(Page $language)
None

Hook called when a language is deleted

Languages::updated(Page $language, string $what)
None

Hook called when a language is added or deleted

Properties

NameReturnSummary 
Languages::default Language Get default language 

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.252