php8.5
Home/ Manual/ intl / collator/ Collator::sortWithSortKeys

Collator::sortWithSortKeys

PHP function Edit on GitHub ✎

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

Sort array using specified collator and sort keys

Description

Oop

Collator::sortWithSortKeys(array $array): bool

Procedural

collator_sort_with_sort_keys(Collator $object, array $array): bool

Similar to collator_sort() but uses ICU sorting keys produced by ucol_getSortKey() to gain more speed on large arrays.

Parameters

object

Collator object.

array

Array of strings to sort

Return Values

Success

Examples

collator_sort_with_sort_keys() example

php
<?php
$arr  = array( 'Köpfe', 'Kypper', 'Kopfe' );
$coll = collator_create( 'sv' );

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

The above example will output:

output
array (
  0 => 'Kopfe',
  1 => 'Kypper',
  2 => 'Köpfe',
)

See Also

Source: reference/intl/collator/sort-with-sort-keys.xml · from the official PHP manual (php/doc-en)