Languages::setLocale() method

Set the current locale

This function behaves exactly the same way as PHP setlocale except for the following:

  • If the $locale argument is omitted, it uses the locale setting translated for the current user language.
  • You can optionally specify a CSV string of locales to try for the $locale argument.
  • You can optionally or a “category=locale;category=locale;category=locale” string for the $locale argument. When this type of string is used, the $category argument is ignored.
  • This method does not accept more than the 3 indicated arguments.
  • Any of the arguments may be swapped.

See the PHP setlocale link above for a list of constants that can be used for the $category argument.

Note that the locale is set once at bootup by ProcessWire, and does not change after that unless you call this method. Meaning, a change to $user->language does not automatically change the locale. If you want to change the locale, you would have to call this method after changing the user’s language from the API side.

Example

// Set locale to whatever settings defined for current $user language
$languages->setLocale();

// Set all locale categories
$languages->setLocale(LC_ALL, 'en_US.UTF-8');

// Set locale for specific category (CTYPE)
$langauges->setLocale(LC_CTYPE, 'en_US.UTF-8');

// Try multiple locales till one works (in order) using array
$languages->setLocale(LC_ALL, [ 'en_US.UTF-8', 'en_US', 'en' ]);

// Same as above, except using CSV string
$languages->setLocale(LC_ALL, 'en_US.UTF-8, en_US, en');

// Set multiple categories and locales (first argument ignored)
$languages->setLocale(null, 'LC_CTYPE=en_US;LC_NUMERIC=de_DE;LC_TIME=es_ES'); 

Usage

// basic usage
$string = $languages->setLocale();

// usage with all arguments
$string = $languages->setLocale($category = 6, $locale = null);

Arguments

NameType(s)Description
category (optional)int, string, array, null, Language

Specify a PHP “LC_” constant (int) or omit (or null) for default (LC_ALL).

locale (optional)int, string, array, null, Language

Specify string, array or CSV string of locale name(s), omit (null) for current language locale, or specify Language object to pull locale from that language.

Return value

string bool

Returns the locale that was set or boolean false if requested locale cannot be set.

See Also


Languages methods and properties

API reference based on ProcessWire core version 3.0.155

Twitter updates

  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020
  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020

Latest news

  • ProcessWire Weekly #311
    In the 311th issue of ProcessWire Weekly we're going to talk a bit about the latest dev versions of ProcessWire, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 25 April 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull