setlocale

Set locale information.

setlocale Function synopsis

setlocale(
    int $category,
    $locales,
    ...$rest
  ): string|false

Parameters

$category

Typeint

$category is a named constant specifying the category of the functions affected by the locale setting:

$locales

If $locales is the empty string "" or is null, the locale names will be set from the values of environment variables with the same names as the above categories, or from "LANG".

$rest

Variadic, Optional

Optional string parameters to try as locale settings until success.

Return value

Typestring|false

Returns the new current locale, or false if the locale functionality is not implemented on your platform, the specified locale does not exist or the category name is invalid.

An invalid category name also causes a warning message. Category/locale names can be found in RFC 1766 and ISO 639. Different systems have different naming schemes for locales.

The return value of [`setlocale`](/codex/setlocale) depends
on the system that PHP is running.  It returns exactly
what the system `setlocale` function returns.