array_rand

(PHP 4, PHP 5, PHP 7, PHP 8)

array_randPrend une ou plusieurs clés, au hasard dans un tableau

Description

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

Sélectionne une ou plusieurs valeurs au hasard dans un tableau et retourne la ou les clés de ces valeurs.

Attention

Cette fonction ne génère pas de valeurs cryptographiquement sûres, et ne doit pas être utilisée à des fins cryptographiques, ou à des fins qui exigent que les valeurs renvoyées soient indéchiffrables.

Si de l'aléatoire cryptographiquement sûre est requis, le Random\Randomizer peut être utilisé avec le moteur Random\Engine\Secure. Pour des cas d'usage simple, les fonctions random_int() et random_bytes() fournissent une API pratique et sûre qui est qui est soutenu par le CSPRNG du système d'exploitation.

Attention

Cette fonction utilise l'instance globale Mt19937 ("Mersenne Twister") comme source d'aléatoire et partage ainsi son état avec toutes les autres fonctions utilisant le Mt19937 global. L'utilisation de l'une de ces fonctions fait avancer la séquence pour toutes les autres fonctions, indépendamment de la portée.

Générer des séquences reproductibles en initialisant mt_srand() ou srand() avec une valeur connue produira également une sortie reproductible de cette fonction.

Il est préférable d'utiliser les méthodes de Random\Randomizer dans tout nouveau code.

Liste de paramètres

array

Le tableau d'entrée. Ne peut pas être vide.

num

Spécifie le nombre d'entrées que l'on veut récupérer. Doit être supérieur à zéro et inférieur ou égal à la longueur de array.

Valeurs de retour

Lorsque l'on ne récupère qu'une seule entrée, la fonction array_rand() retourne la clé d'une entrée choisie aléatoirement. Sinon, un tableau de clés d'entrées aléatoires sera retourné. Cela permet de faire une sélection au hasard de clés, ou bien de valeurs. Si plusieurs clés sont retournées, alors elles le seront dans l'ordre qu'elles étaient dans le tableau d'origine.

Erreurs / Exceptions

Lance une ValueError si array est vide, ou si num est hors de portée.

Historique

Version Description
8.0.0 array_rand() lance désormais une ValueError si num est hors de portée ; précédemment, un E_WARNING était généré et la fonction renvoyait null.
8.0.0 array_rand() lance désormais une ValueError si array est vide ; précédemment, un E_WARNING était généré et la fonction renvoyait null.
7.1.0 L'algorithme interne de génération aléatoire a été modifié pour utiliser le générateur aléatoire de nombre »  Mersenne Twister au lieu de la fonction aléatoire libc

Exemples

Exemple #1 Exemple avec array_rand()

<?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";
?>

Voir aussi