Please wait while we load your page...


PHP Manual :: Collator::getLocale

Collator::getErrorMessage || Collator::getSortKey || Collator || PHP Manual

(PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0)

Collator::getLocale -- collator_get_localeGet the locale name of the collator


Object oriented style

public string Collator::getLocale ( int $type )

Procedural style

string collator_get_locale ( Collator $coll , int $type )

Get collector locale name.



Collator object.


You can choose between valid and actual locale ( Locale::VALID_LOCALE and Locale::ACTUAL_LOCALE, respectively).

Return Values

Real locale name from which the collation data comes. If the collator was instantiated from rules or an error occurred, returns boolean FALSE.


Example #1 collator_get_locale() example

collator_create'en_US_California' );
$res_val collator_get_locale$collLocale::VALID_LOCALE );
$res_act collator_get_locale$collLocale::ACTUAL_LOCALE );
printf"Valid locale name: %s\nActual locale name: %s\n",
$res_val$res_act );

The above example will output:

Requested locale name: en_US_California
Valid locale name: en_US
Actual locale name: en

See Also

Collator::getErrorMessage || Collator::getSortKey || Collator || PHP Manual
Live Chat Not Available