WireArray class

WireArray is the base iterable array type used throughout the ProcessWire framework.

Nearly all collections of items in ProcessWire are derived from the WireArray type. This includes collections of pages, fields, templates, modules and more. As a result, the WireArray class is one you will be interacting with regularly in the ProcessWire API, whether you know it or not.

Below are all the public methods you can use to interact with WireArray types in ProcessWire. In addition to these methods, you can also treat WireArray types like regular PHP arrays, in that you can foreach() them and get or set elements using array syntax, i.e. $value = $items[$key]; to get an item or $items[] = $item; to add an item.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireArray class also inherits all the methods and properties of: Wire.

Traversal

Name	Return	Summary
WireArray::and() WireArray::and($item) WireArray::and($item)	`WireArray`	Return a new copy of this WireArray with the given item(s) appended
WireArray::each() WireArray::each() WireArray::each($func = null)	`array` `null` `string` `WireArray`	Perform an action upon each item in the WireArray
WireArray::first() WireArray::first() WireArray::first()	`Wire` `mixed` `bool`	Returns the first item in the WireArray or boolean false if empty. Can also be used as property: WireArray::first
WireArray::getIterator() WireArray::getIterator() WireArray::getIterator()	`ArrayObject` `Wire`	Allows iteration of the WireArray.
WireArray::last() WireArray::last() WireArray::last()	`Wire` `mixed` `bool`	Returns the last item in the WireArray or boolean false if empty. Can also be used as property: WireArray::last
WireArray::slices() WireArray::slices(int $qty) WireArray::slices(int $qty)	`array`	Divide this WireArray into $qty slices and return array of them (each being another WireArray)

Retrieval

Name	Return	Summary
WireArray::count() WireArray::count() WireArray::count()	`int`	Returns the number of items in this WireArray. Can also be used as property: WireArray::count
WireArray::eq() WireArray::eq(int $num) WireArray::eq(int $num)	`Wire` `null`	Returns the item at the given index starting from 0, or NULL if it doesn't exist.
WireArray::explode() WireArray::explode() WireArray::explode($property = '', array $options = [])	`array`	Return a plain array of the requested property from each item
WireArray::find() WireArray::find($selector) WireArray::find($selector)	`WireArray`	Find all items in this WireArray that match the given selector.
WireArray::findOne() WireArray::findOne($selector) WireArray::findOne($selector)	`Wire` `bool`	Find a single item by selector
WireArray::findRandom() WireArray::findRandom(int $num) WireArray::findRandom(int $num)	`WireArray`	Find a specified quantity of random elements from this WireArray.
WireArray::findRandomTimed() WireArray::findRandomTimed(int $num) WireArray::findRandomTimed(int $num, $seed = 'Ymd')	`WireArray`	Find a quantity of random elements from this WireArray based on a timed interval (or user provided seed).
WireArray::first() WireArray::first() WireArray::first()	`Wire` `mixed` `bool`	Returns the first item in the WireArray or boolean false if empty. Can also be used as property: WireArray::first
WireArray::get() WireArray::get($key) WireArray::get($key)	`WireData` `Page` `mixed` `array` `null`	Returns the value of the item at the given index, or null if not set.
WireArray::getAll() WireArray::getAll() WireArray::getAll()	`$this`	Returns all items in the WireArray (for syntax convenience)
WireArray::getArray() WireArray::getArray() WireArray::getArray()	`array`	Get a PHP array of all the items in this WireArray with original keys maintained
WireArray::getKeys() WireArray::getKeys() WireArray::getKeys()	`array`	Returns a regular PHP array of all keys used in this WireArray.
WireArray::getNext() WireArray::getNext(Wire $item) WireArray::getNext(Wire $item, bool $strict = true)	`Wire` `null`	Given an item, get the item that comes after it in the WireArray
WireArray::getPrev() WireArray::getPrev(Wire $item) WireArray::getPrev(Wire $item, bool $strict = true)	`Wire` `null`	Given an item, get the item before it in the WireArray
WireArray::getProperty() WireArray::getProperty(string $property) WireArray::getProperty(string $property)	`Wire` `mixed`	Get a predefined property of the array, or extra data that has been set.
WireArray::getRandom() WireArray::getRandom() WireArray::getRandom(int $num = 1, bool $alwaysArray = false)	`WireArray` `Wire` `mixed` `null`	Get a random item from this WireArray.
WireArray::getValues() WireArray::getValues() WireArray::getValues()	`array` `Wire`	Returns a regular PHP array of all values used in this WireArray.
WireArray::has() WireArray::has($key) WireArray::has($key)	`bool`	Does this WireArray have the given item, index, or match the given selector?
WireArray::implode() WireArray::implode(string $delimiter) WireArray::implode(string $delimiter, $property = '', array $options = [])	`string`	Combine all elements into a delimiter-separated string containing the given property from each item
WireArray::index() WireArray::index(int $num) WireArray::index(int $num)	`WireArray`	Returns a new WireArray of the item at the given index.
WireArray::last() WireArray::last() WireArray::last()	`Wire` `mixed` `bool`	Returns the last item in the WireArray or boolean false if empty. Can also be used as property: WireArray::last
WireArray::pop() WireArray::pop() WireArray::pop()	`Wire` `mixed` `null`	Pop an element off the end of the WireArray and return it
WireArray::reverse() WireArray::reverse() WireArray::reverse()	`WireArray`	Return a new reversed version of this WireArray.
WireArray::shift() WireArray::shift() WireArray::shift()	`Wire` `mixed` `null`	Shift an element off the beginning of the WireArray and return it
WireArray::slice() WireArray::slice(int $start) WireArray::slice(int $start, int $limit = 0)	`WireArray`	Get a slice of the WireArray.
WireArray::slices() WireArray::slices(int $qty) WireArray::slices(int $qty)	`array`	Divide this WireArray into $qty slices and return array of them (each being another WireArray)
WireArray::unique() WireArray::unique() WireArray::unique(int $sortFlags = 2)	`WireArray`	Return a new array that is unique (no two of the same elements)

Manipulation

Name	Return	Summary
WireArray::add() WireArray::add($item) WireArray::add($item)	`$this`	Add an item to the end of the WireArray.
WireArray::append() WireArray::append($item) WireArray::append($item)	`$this`	Append an item to the end of the WireArray
WireArray::filter() WireArray::filter($selector) WireArray::filter($selector)	`$this`	Filter this WireArray to only include items that match the given selector (destructive)
WireArray::import() WireArray::import($items) WireArray::import($items)	`$this`	Import the given item(s) into this WireArray.
WireArray::insertAfter() WireArray::insertAfter($item, $existingItem) WireArray::insertAfter($item, $existingItem)	`$this`	Insert an item after an existing item
WireArray::insertBefore() WireArray::insertBefore($item, $existingItem) WireArray::insertBefore($item, $existingItem)	`$this`	Insert an item before an existing item
WireArray::not() WireArray::not($selector) WireArray::not($selector)	`$this`	Filter this WireArray to only include items that DO NOT match the selector (destructive)
WireArray::pop() WireArray::pop() WireArray::pop()	`Wire` `mixed` `null`	Pop an element off the end of the WireArray and return it
WireArray::prepend() WireArray::prepend($item) WireArray::prepend($item)	`$this`	Prepend an item to the beginning of the WireArray.
WireArray::push() WireArray::push($item) WireArray::push($item)	`$this`	Push an item to the end of the WireArray.
WireArray::remove() WireArray::remove($key) WireArray::remove($key)	`$this`	Removes the given item or index from the WireArray (if it exists).
WireArray::removeAll() WireArray::removeAll() WireArray::removeAll()	`$this`	Removes all items from the WireArray, leaving it blank
WireArray::removeItems() WireArray::removeItems($items) WireArray::removeItems($items)	`$this`	Removes multiple identified items at once
WireArray::replace() WireArray::replace($itemA, $itemB) WireArray::replace($itemA, $itemB)	`$this`	Replace one item with the other
WireArray::set() WireArray::set($key, $value) WireArray::set($key, $value)	`$this`	Set an item by key in the WireArray.
WireArray::setArray() WireArray::setArray($data) WireArray::setArray($data)	`$this`	Like set() but accepts an array or WireArray to set multiple values at once
WireArray::shift() WireArray::shift() WireArray::shift()	`Wire` `mixed` `null`	Shift an element off the beginning of the WireArray and return it
WireArray::shuffle() WireArray::shuffle() WireArray::shuffle()	`$this`	Shuffle/randomize this WireArray
WireArray::sort() WireArray::sort($properties) WireArray::sort($properties, $flags = null)	`$this`	Sort this WireArray by the given properties.
WireArray::sortFlags() WireArray::sortFlags() WireArray::sortFlags(bool $sortFlags = false)	`int`	Get or set sort flags that affect behavior of any sorting functions
WireArray::unshift() WireArray::unshift($item) WireArray::unshift($item)	`$this`	Unshift an element to the beginning of the WireArray (alias for prepend)

Info

Name	Return	Summary
WireArray::has() WireArray::has($key) WireArray::has($key)	`bool`	Does this WireArray have the given item, index, or match the given selector?
WireArray::isIdentical() WireArray::isIdentical(WireArray $items) WireArray::isIdentical(WireArray $items, $strict = true)	`bool`	Is the given WireArray identical to this one?
WireArray::isValidItem() WireArray::isValidItem(mixed $item) WireArray::isValidItem(mixed $item)	`bool`	Is the given item valid for storange in this array?
WireArray::isValidKey() WireArray::isValidKey($key) WireArray::isValidKey($key)	`bool`	Is the given item key valid for use in this array?
WireArray::iterable() WireArray::iterable(mixed $item) WireArray::iterable(mixed $item)	`bool`	Determines if the given item iterable as an array.

Output rendering

Name	Return	Summary
WireArray::each() WireArray::each() WireArray::each($func = null)	`array` `null` `string` `WireArray`	Perform an action upon each item in the WireArray
WireArray::implode() WireArray::implode(string $delimiter) WireArray::implode(string $delimiter, $property = '', array $options = [])	`string`	Combine all elements into a delimiter-separated string containing the given property from each item

Other data storage

Name	Return	Summary
WireArray::data() WireArray::data() WireArray::data($key = null, $value = null)	`WireArray` `mixed` `array` `null`	Store or retrieve an extra data value in this WireArray
WireArray::removeData() WireArray::removeData(string $key) WireArray::removeData(string $key)	`$this`	Remove a property/value previously set with the WireArray::data() method.

Changes

Name	Return	Summary
WireArray::getItemsAdded() WireArray::getItemsAdded() WireArray::getItemsAdded()	`array` `Wire`	Return array of all items added to this WireArray (while change tracking is enabled)
WireArray::getItemsRemoved() WireArray::getItemsRemoved() WireArray::getItemsRemoved()	`array` `Wire`	Return array of all items removed from this WireArray (when change tracking is enabled)

Fun tools

Name	Return	Summary
WireArray::and() WireArray::and($item) WireArray::and($item)	`WireArray`	Return a new copy of this WireArray with the given item(s) appended
WireArray::callUnknown() WireArray::callUnknown(string $method, array $arguments) WireArray::callUnknown(string $method, array $arguments)	`null` `mixed`	Handler for when an unknown/unhooked method call is executed
WireArray::each() WireArray::each() WireArray::each($func = null)	`array` `null` `string` `WireArray`	Perform an action upon each item in the WireArray
WireArray::explode() WireArray::explode() WireArray::explode($property = '', array $options = [])	`array`	Return a plain array of the requested property from each item
WireArray::implode() WireArray::implode(string $delimiter) WireArray::implode(string $delimiter, $property = '', array $options = [])	`string`	Combine all elements into a delimiter-separated string containing the given property from each item

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
WireArray::callUnknown() WireArray::callUnknown(string $method, array $arguments) WireArray::callUnknown(string $method, array $arguments)	`null` `mixed`	Handler for when an unknown/unhooked method call is executed

Common

Name	Return	Summary
WireArray::WireArray new() WireArray::WireArray new() WireArray::WireArray new($items = array)	`static`	)
WireArray::keys	`array`	All keys used in this WireArray
WireArray::setDuplicateChecking() WireArray::setDuplicateChecking(bool $value) WireArray::setDuplicateChecking(bool $value)	(nothing)	Set the current duplicate checking state
WireArray::values	`array`	All values used in this WireArray

Additional methods and properties

In addition to the methods and properties above, WireArray also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.236