collator_sort

Function • Params and return types changed in PHP 8.0
PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

collator_sort Function synopsis

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

Parameters

$object

TypeCollator

$array

Passed by referenceTypearray

$flags

OptionalTypeintDefault valueCollator::SORT_REGULAR

Note that the parameter $array is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typebool

Changes to the collator_sort Function

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #2 changed: $arr to $array
  • Parameter name of parameter #3 changed: $sort_flags to $flags
  • Parameter type added for parameter #3 ($flags): int
  • Parameter default value added for position #3 ($flags): Collator::SORT_REGULAR
  collator_sort(
      Collator $object,
-     array &$arr,
+     array &$array,
-     $sort_flags
+     int $flags = Collator::SORT_REGULAR
-   )
+   ): bool

collator_sort Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes