PHP shuffle() Function

Welcome to our comprehensive guide on the PHP shuffle function. In this article, we will explain what the shuffle function does, how it works, and provide practical examples of how to use it in your PHP projects.

The shuffle function in PHP is a built-in function that shuffles the elements of an array randomly. It modifies the original array in place and returns a boolean value (true on success, false on failure).

The shuffle function works by rearranging the elements of an array in a random order. It uses PHP's random number generator to ensure each permutation is equally likely.

Here is the syntax for the shuffle function:

shuffle(array &$array): bool // Note: array type hint requires PHP 8.0+

The $array parameter is passed by reference, meaning the original array is modified directly. The function returns true on success or false on failure.

Note: In PHP 8.1+, passing a non-array value to shuffle() triggers a deprecation warning.

Let's take a look at some practical examples of using the shuffle function in PHP.

Example 1: Shuffling an Array of Numbers

Example of Shuffling an Array of Numbers in PHP

<‌?php

$numbers = [1, 2, 3, 4, 5];
shuffle($numbers);
print_r($numbers);

Try it Yourself »

Output:

Array
(
    [0] => 5
    [1] => 1
    [2] => 4
    [3] => 3
    [4] => 2
)

Example 2: Shuffling an Array of Strings

Example of Shuffling an Array of Strings in PHP

<‌?php

$fruits = ["apple", "banana", "orange", "kiwi", "grape"];
shuffle($fruits);
print_r($fruits);

Try it Yourself »

Output:

Array
(
    [0] => kiwi
    [1] => banana
    [2] => grape
    [3] => apple
    [4] => orange
)

Example 3: Shuffling an Associative Array

Example of Shuffling an Associative Array in PHP

Note that shuffle() always reindexes arrays to sequential numeric keys, destroying any existing string keys. To preserve associative keys, you must shuffle the keys manually as shown below.

<‌?php

$person = ["name" => "John", "age" => 30, "city" => "New York"];

// Shuffle the keys of the array
$keys = array_keys($person);
shuffle($keys);

// Create a new array with the shuffled keys
$shuffled_person = [];
foreach ($keys as $key) {
    $shuffled_person[$key] = $person[$key];
}

print_r($shuffled_person);

Try it Yourself »

Output:

Array
(
    [city] => New York
    [age] => 30
    [name] => John
)

In this article, we have explained what the shuffle function is, how it works, and provided practical examples of how to use it in your own PHP projects. We hope that this guide has been helpful to you and that you can now use the shuffle function with confidence.

Diagram:

Thank you for reading our guide on the shuffle() function in PHP. If you have any questions or feedback, please feel free to contact us.

Practice

What is the purpose of the shuffle() function in PHP?

The shuffle() function is used to insert an element at the end of an array.The shuffle() function is used to sort an array in ascending order.The shuffle() function is used to randomize the order of elements in an array.The shuffle() function is used to delete an element from an array.