array_rand
(PHP 4, PHP 5, PHP 7, PHP 8)
array_rand — Liefert einen oder mehrere zufällige Schlüssel eines Arrays
Beschreibung
$array
, int $num
= 1): int|string|arrayWählt einen oder mehrere Einträge aus einem Array aus und gibt den Schlüssel des zufälligen Eintrags bzw. die Schlüssel der zufälligen Einträge zurück. Es wird ein Pseudo-Zufallszahlengenerator verwendet, der nicht für kryptographische Zwecke geeignet ist.
Parameter-Liste
-
array
-
Das Eingabe-Array.
-
num
-
Gibt an, wie viele Einträge ausgewählt werden sollen.
Rückgabewerte
Wenn nur ein Eintrag ausgewählt wird, gibt array_rand()
den Schlüssel eines zufälligen Eintrages zurück. Andernfalls wird ein Array
mit den Schlüsseln der zufälligen Einträge zurückgegeben. Dies hat den
Zweck, dass zufällige Schlüssel und auch Werte aus dem Array ausgewählt
werden können. Wenn mehrere Schlüssel zurückgegeben werden, werden sie in
der Reihenfolge zurückgegeben, in der sie im ursprünglichen Array
vorliegen. Der Versuch, mehr Elemente auszuwählen als im Array vorhanden
sind, ergibt einen Fehler der Stufe E_WARNING
und NULL
wird zurückgegeben.
Changelog
Version | Beschreibung |
---|---|
7.1.0 | Zur Erzeugung der Zufallszahlen kommt intern nun der » Mersenne-Primzahlen-Zufallsgenerator statt der vorherigen libc-rand-Funktion zum Einsatz. |
Beispiele
Beispiel #1 array_rand()-Beispiel
<?php
$input = array("Neo", "Morpheus", "Trinity", "Cypher", "Tank");
$rand_keys = array_rand($input, 2);
echo $input[$rand_keys[0]] . "\n";
echo $input[$rand_keys[1]] . "\n";
?>