Skip to content

Kirby 5.0.0

$pages->sort()

Sorts the elements by any number of fields

$pages->sort(string|callable $field, string|null $direction, int|null $method): Kirby\Cms\Pages

Parameters

Name Type Default Description
$fieldrequired stringorcallable no default value Field name or value callback to sort by
$direction stringornull no default value asc or desc
$method intornull no default value The sort flag, SORT_REGULAR, SORT_NUMERIC etc.

Return types

Kirby\Cms\Pages

This method does not modify the existing $pages object but returns a new object with the changes applied. Learn more →

Parent class

Kirby\Cms\Pages inherited from Kirby\Toolkit\Collection

Examples

$collection->sort('fieldName');
$collection->sort('fieldName', 'desc');
$collection->sort('fieldName', 'asc', SORT_REGULAR);
$collection->sort(fn ($a) => ...);