Collator::create
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)
Create a collator
Description
Oop
Collator::create(string $locale): Collator|null
Procedural
collator_create(string $locale): Collator|null
The strings will be compared using the options already specified.
Parameters
localeThe locale containing the required collation rules. Special values for locales can be passed in - if an empty String is passed for the locale, the default locale collation rules will be used. If
"root"is passed, UCA rules will be used.
Return Values
Return new instance of Collator object, or null on error.
Examples
collator_create() example
php
<?php
$coll = collator_create( 'en_US' );
if( !isset( $coll ) ) {
printf( "Collator creation failed: %s\n", intl_get_error_message() );
exit( 1 );
}
?>