Collator::sort

collator_sort

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

Collator::sort -- collator_sort — Sort array using specified collator

Object-oriented style

publicCollator::sort(array&$array, int$flags = Collator::SORT_REGULAR): bool

Procedural style

collator_sort(Collator$object, array&$array, int$flags = Collator::SORT_REGULAR): bool

This function sorts an array according to current locale rules.

Equivalent to standard PHP sort() .

object

Collator object.

array

Array of strings to sort.

flags

Optional sorting type, one of the following:

Default sorting type is Collator::SORT_REGULAR. It is also used if an invalid flags value has been specified.

Returns true on success or false on failure.

Example #1 collator_sort() example

<?php
$coll = collator_create( 'en_US' );
$arr = array( 'at', 'às', 'as' );

var_export( $arr );
collator_sort( $coll, $arr );
var_export( $arr );
?>

The above example will output:

array ( 0 => 'at', 1 => 'às', 2 => 'as', )array ( 0 => 'as', 1 => 'às', 2 => 'at', )