WireArray::explode() method

Return a plain array of the requested property from each item

You may provide an array of properties as the $property, in which case it will return an array of associative arrays with all requested properties for each item.

You may also provide a function as the $property. That function receives the $item as the first argument and $key as the second. It should return the value that will be stored.

The keys of the returned array remain consistent with the original WireArray.

Usage

// basic usage
$array = $wireArray->explode();

// usage with all arguments
$array = $wireArray->explode($property = '', array $options = []);

Arguments

NameType(s)Description
property (optional)string, callable, array

Property or properties to retrieve, or callable function that should receive items.

options (optional)array

Options to modify default behavior:

  • getMethod (string): Method to call on each item to retrieve $property (default = "get")
  • key (string|null): Property of Wire objects to use for key of array, or omit (null) for non-associative array (default).

Return value

array

See Also


WireArray methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.