Description

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

Signature alternative (non supportée avec les arguments nommés) :

setlocale(int $category, array $locale_array): string|false

Définit les informations de localisation.

Avertissement

L'information locale est maintenue par processus, non par thread. Si l'on fait fonctionner PHP sur un serveur multithreadé, il serait possible d'obtenir des changements soudains des configurations locales pendant qu'un script fonctionne, même si celui-ci n'appelle jamais la fonction setlocale(). Ceci survient à cause des autres scripts qui fonctionnent dans des threads différents du même processus. Ces scripts changent les configurations locales dans le processus au complet en utilisant la fonction setlocale(). Sur Windows, les informations de locale sont maintenue par thread à partir de PHP 7.0.5.

Liste de paramètres

category

category est une constante (ou une chaîne) qui spécifie la catégorie de fonctions affectées par la configuration de localisation :

LC_ALL pour toutes les constantes suivantes
LC_COLLATE pour la comparaison de chaînes de caractères. Voir strcoll()
LC_CTYPE pour la classification et la conversion de caractères. Voir ctype_alpha()
LC_MONETARY pour localeconv()
LC_NUMERIC pour le séparateur décimal. Voir localeconv()
LC_TIME pour le format de date et d'heure avec strftime()
LC_MESSAGES pour les réponses système (disponible si PHP a été compilé avec libintl)

locales

Si locales est la chaîne vide "" ou est null, les noms de locales seront pris dans l'environnement, à partir des variables de même nom que les catégories ci-dessus, ou depuis "LANG".

Si locales vaut "0", la configuration locale ne sera pas modifiée, et la configuration courante sera retournée.

Si locales est suivi par des paramètres additionnels, alors chaque paramètre tente d'être défini comme nouvelle locale jusqu'à ce qu'un réussisse. Cela est pratique si la locale est connue sous différents noms sur des systèmes différents ou bien pour prévoir une autre valeur en cas de non disponibilité de la locale choisie.

rest

Paramètres optionnels de chaîne à essayer comme paramètre de locale jusqu'à une réussite.

locale_array

Chaque élément du tableau est essayé pour être défini comme la nouvelle locale jusqu'à une réussite. Ceci est utile si une locale est connue sous différents noms sur des systèmes différents ou pour fournir une solution de repli pour une locale potentiellement indisponible.

Note:
Sous Windows, setlocale(LC_ALL, '') définit les noms de la locale depuis la configuration de la langue/de la région du système d'exploitation (accessible depuis le Panneau de Contrôle).

Valeurs de retour

Retourne la nouvelle configuration locale, ou false si la localisation n'est pas implémentée sur le plate-forme, si la variable de localisation n'existe pas, ou si la catégorie spécifiée n'est pas valide.

Un nom de catégorie invalide générera un message d'alerte. La liste des noms de locales/catégories peut être trouvée en consultant la » RFC 1766 ainsi que l'» ISO 639. Les différentes plates-formes possèdent des conventions de nommages différentes.

Note:
La valeur retournée par setlocale() dépend du système sur lequel PHP est installé. setlocale() retourne exactement ce que la fonction système setlocale retourne.

Historique

Version	Description
8.5.0	Passer un entier `0` comme argument `locales` n'est plus supporté et lance désormais une TypeError.

Exemples

Exemple #1 Exemple avec setlocale()

<?php
/* Configure le script en hollandais */
setlocale(LC_ALL, 'nl_NL');

/* Affiche : vrijdag 22 december 1978 */
echo strftime("%A %e %B %Y", mktime(0, 0, 0, 12, 22, 1978));

/* Essai de différentes valeurs possible pour l'allemand */
$loc_de = setlocale(LC_ALL, 'de_DE@euro', 'de_DE', 'de', 'ge');
echo "L'identifiant de l'allemand sur ce système est '$loc_de'";
?>

Exemple #2 Récupérer le paramètre actuel de setlocale()

<?php
/* Récupérer le paramètre actuel */
$current = setlocale(LC_ALL, null);

echo "Locale actuelle '$current'";
?>

Exemple #3 Exemple avec setlocale() sous Windows

<?php
/* Configure le script en hollandais */
setlocale(LC_ALL, 'nld_nld');

/* Affiche : vrijdag 22 december 1978 */
echo strftime("%A %d %B %Y", mktime(0, 0, 0, 12, 22, 1978));

/* Essai de différentes valeurs possible pour l'allemand */
$loc_de = setlocale(LC_ALL, 'de_DE@euro', 'de_DE', 'deu_deu');
echo "L'identifiant de l'allemand sur ce système est '$loc_de'";
?>

Notes

Astuce

Les utilisateurs de Windows trouveront des informations utiles à propos du paramètre locales sur le site web MSDN de Microsoft. Les valeurs de locales supportées peuvent être trouvées » sur la page de la documentation des chaînes du langage et les chaînes de pays/région » sur la page de la documentation des chaînes de pays/région.