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.200

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer