shuffle() - 配列をシャッフルする

公開日: 2016/12/20

shuffleは、指定した配列をシャッフルして並び順をランダムにする関数です。元の配列を変更します。キーと値の関係は維持されません。

構文

bool shuffle ( array &$array )

パラメータ

&$array

対象の配列。

返り値

bool

シャッフルに成功した場合はtrue、失敗した場合はfalseを返す。

サンプルコード

配列をシャッフルする

配列をシャッフルして、並び順をバラバラにします。

php

<?php
	// 配列
	$queue = [ "a", "b", "c", "d", "e" ] ;

	// 実行
	$result = shuffle( $queue ) ;

	// 結果
	var_dump( $result ) ;	// 返り値
	echo "\n" ;
	print_r( $queue ) ;	// 実行後の配列

結果 (出力内容) - PHP7.0.21

bool(true)

Array
(
    [0] => d
    [1] => b
    [2] => e
    [3] => a
    [4] => c
)

キーと値の関係は維持されない

この関数はキーと値の関係を維持しません。連想配列をシャッフルする時はご注意下さい。

php

<?php
	// 配列
	$queue = [
		"A" => "a" ,
		"B" => "b" ,
		"C" => "c" ,
		"D" => "d" ,
		"E" => "e" ,
	] ;

	// 実行
	$result = shuffle( $queue ) ;

	// 結果
	var_dump( $result ) ;	// 返り値
	echo "\n" ;
	print_r( $queue ) ;	// 実行後の配列

結果 (出力内容) - PHP7.0.21

bool(true)

Array
(
    [0] => c
    [1] => b
    [2] => d
    [3] => e
    [4] => a
)

サンドボックス

ソースコードを編集してshuffle()の挙動を確認して下さい。

CODE
RUN

bool(true)

Array
(
    [0] => b
    [1] => c
    [2] => d
    [3] => a
    [4] => e
)

参考リンク

PHP - 公式マニュアル。