Get a random item from this WireArray.
- If one item is requested (default), the item is returned (unless
$alwaysArray
argument is true). - If multiple items are requested, a new
WireArray
of those items is returned. - We recommend using this method when you just need 1 random item, and using the
WireArray::findRandom()
method when you need multiple random items.
Example
// Get a single random item
$randomItem = $items->getRandom();
// Get 3 random items
$randomItems = $items->getRandom(3);
Usage
// basic usage
$items = $wireArray->getRandom();
// usage with all arguments
$items = $wireArray->getRandom(int $num = 1, bool $alwaysArray = false);
Arguments
Name | Type(s) | Description |
---|---|---|
num (optional) | int | Number of items to return. Optional and defaults to 1. |
alwaysArray (optional) | bool | If true, then method will always return an array of items, even if it only contains 1 item. |
Return value
See Also
WireArray methods and properties
API reference based on ProcessWire core version 3.0.236