Set current user to have default language temporarily

If given no arguments, it sets the current $user to have the default language temporarily. It is expected you will follow it up with a later call to $languages->unsetDefault() to restore the previous language the user had.

If given a Language object, it sets that as the default language (for internal use only).

Example

// set current user to have default language
$languages->setDefault();
// perform some operation that has a default language dependency ...
// then restore the user's previous language with unsetDefault()
$languages->unsetDefault();

Usage

// basic usage
$ = $languages->setDefault();

// usage with all arguments
$ = $languages->setDefault(Language $language = null);

Arguments

NameType(s)Description
$language (optional)Language

See Also


Languages methods and properties

API reference based on ProcessWire core version 3.0.109