WireArray::getRandom() method

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

NameType(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

WireArray Wire mixed null

Returns value of item, or new WireArray of items if more than one requested.

See Also


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

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani