WireArray::sort() method

Sort this WireArray by the given properties.

  • Sort properties can be given as a string in the format name, datestamp or as an array of strings, i.e. ["name", "datestamp"].

  • You may also specify the properties as property.subproperty, where property resolves to a Wire derived object in each item, and subproperty resolves to a property within that object.

  • Prepend or append a minus "-" to reverse the sort (per field).

Example

// Sort newest to oldest
$items->sort("-created");

// Sort by last_name then first_name
$items->sort("last_name, first_name"); 

Usage

// basic usage
$wireArray->sort($properties);

// usage with all arguments
$wireArray->sort($properties, $flags = null);

Arguments

NameType(s)Description
propertiesstring, array

Field names to sort by (CSV string or array).

flags (optional)int, null

Optionally specify sort flags (see sortFlags method for details).

Return value

$this

reference to current instance.


WireArray methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull