Please wait while we load your page...


PHP Manual :: Collator::compare

Collator::asort || Collator::__construct || Collator || PHP Manual

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

Collator::compare -- collator_compareCompare two Unicode strings


Object oriented style

public int Collator::compare ( string $str1 , string $str2 )

Procedural style

int collator_compare ( Collator $coll , string $str1 , string $str2 )

Compare two Unicode strings according to collation rules.



Collator object.


The first string to compare.


The second string to compare.

Return Values

Return comparison result:

  • 1 if str1 is greater than str2 ;

  • 0 if str1 is equal to str2;

  • -1 if str1 is less than str2 .

On error boolean FALSE is returned.


This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.


Example #1 collator_compare()example

$s2 'hello';

$coll collator_create'en_US' );
$res  collator_compare$coll$s1$s2 );

if (
$res === false) {
collator_get_error_message$coll );
} else if( 
$res ) {
"s1 is greater than s2\n";
} else if( 
$res ) {
"s1 is less than s2\n";
} else {
"s1 is equal to s2\n";

The above example will output:

s1 is greater than s2

See Also

Collator::asort || Collator::__construct || Collator || PHP Manual
Live Chat Not Available