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

Twitter updates

  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019
  • ProcessWire 3.0.136 updates our CKEditor version and adds a new backtrace() method to the core Debug class— More
    26 July 2019

Latest news

  • ProcessWire Weekly #275
    In the 275th issue of ProcessWire Weekly we're going to walk you through the new features included in ProcessWire 3.0.138, cover some WebP related stuff, and highlight recent forum posts and online resources. Read on!
    Weekly.pw / 17 August 2019
  • WebP images on an existing site
    In this post we’ll look at a process used for migrating an existing website to use WebP images. We’ll cover everything from preliminary considerations to implementation and testing, with lots of tips and tricks along the way.
    Blog / 16 August 2019
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.