Languages::setDefault() method

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

Newest forum posts

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer