関数 array_rand

関数 array_rand は、配列からランダムな キーを返します。第一パラメータには配列を指定し、 第二のオプションパラメータは、 いくつのランダムなキーを返すべきかを指定します。 指定されない場合は1つのキーが返され、 指定された場合は指定された数のキーが 配列の形式で返されます。

構文

phparray_rand(array $array, int $num = 1): int|string|array

例

この例では、関数は配列からランダムなキーを返します:

php<?php
  $arr = ['a'=>1, 'b'=>2, 'c'=>3, 'd'=>4, 'e'=>5];
  echo array_rand($arr);
?>

コード実行結果:

php'c'

例

ランダムなキーを元に、配列からランダムな要素を 返してみましょう:

php<?php
  $arr = ['a'=>1, 'b'=>2, 'c'=>3, 'd'=>4, 'e'=>5];
  
  $key = array_rand($arr);
  echo $arr[$key];
?>

コード実行結果:

php3

例

第二パラメータに値 3 を指定してみましょう - この場合、関数は 3つのランダムなキー(第二パラメータが3なので3つのキー)の 配列を返します:

php<?php
  $arr = ['a'=>1, 'b'=>2, 'c'=>3, 'd'=>4, 'e'=>5];
  
  $keys = array_rand($arr, 3);
  var_dump($keys);
?>

コード実行結果:

php['a', 'b', 'e']

関連項目

  • 関数 shuffle,
    配列をシャッフルします
  • 関数 mt_rand,
    ランダムな数を返します