【PHP8.x】usort関数の使い方

<?php

/**
 * usort 関数を使ったカスタムソートのサンプルコードです。
 * このコードは、連想配列の配列を特定のキー（ここでは 'age'）に基づいてソートする方法を示します。
 */

// ソート対象となる連想配列の配列を準備します。
$users = [
    ['name' => 'Alice', 'age' => 30],
    ['name' => 'Bob', 'age' => 25],
    ['name' => 'Charlie', 'age' => 35],
    ['name' => 'David', 'age' => 25], // 同年齢のユーザーを含める
];

echo "--- ソート前 ---" . PHP_EOL;
print_r($users);

// usort を使用して、$users 配列を 'age' キーに基づいて昇順でソートします。
// 2番目の引数には、比較ロジックを定義するコールバック関数（クロージャ）を渡します。
// コールバック関数は2つの要素 ($a, $b) を受け取り、以下を返します。
//   - $a が $b より小さい場合: 負の値
//   - $a が $b と等しい場合: 0
//   - $a が $b より大きい場合: 正の値
// PHP 7 以降では、<=> (spaceship operator) を使うと簡潔に記述できます。
usort($users, function (array $a, array $b): int {
    // 年齢で比較し、昇順にソートします。
    // 同じ年齢の場合、元の順序が維持されるわけではない点に注意してください。
    return $a['age'] <=> $b['age'];
});

echo "--- 年齢で昇順ソート後 ---" . PHP_EOL;
print_r($users);

// 別の例として、名前でアルファベット順（昇順）にソートする場合
// usort($users, function (array $a, array $b): int {
//     return $a['name'] <=> $b['name'];
// });

// echo "--- 名前で昇順ソート後 ---" . PHP_EOL;
// print_r($users);

PHPのusort関数は、ユーザーが定義したカスタムな比較ルールに基づいて配列をソートするための関数です。通常のソート関数では対応できない、連想配列の特定のキーの値やオブジェクトのプロパティなど、複雑な条件でソートを行いたい場合に特に有効です。

この関数には二つの引数を渡します。最初の引数&$arrayはソート対象となる配列です。この引数は参照渡しされるため、usort関数を実行すると、元の配列そのものがソートされた状態で変更されます。二番目の引数$callbackには、配列内の二つの要素を比較し、その順序を決定するための関数（コールバック関数）を指定します。このコールバック関数は二つの要素を受け取り、最初の要素が二番目の要素より「小さい」と判断される場合は負の値を、「等しい」場合は0を、「大きい」と判断される場合は正の値を返します。

サンプルコードでは、ユーザー情報の連想配列を'age'キーの値に基づいて昇順にソートしています。コールバック関数内で$a['age'] <=> $b['age']と記述することで、PHP 7以降で利用可能な比較演算子（spaceship operator）を使って、この比較ロジックを簡潔に表現しています。usort関数は、ソート処理が成功した場合はtrueを、失敗した場合はfalseをブール値として返します。これにより、開発者は柔軟かつ強力なソート処理を実装することができます。

<?php

/**
 * usort 関数を使用して配列を降順にソートする例
 */
function exampleUsortDescending(): void
{
    // ソート対象の配列を定義
    $numbers = [3, 1, 4, 1, 5, 9, 2, 6];

    echo "ソート前の配列: ";
    print_r($numbers);

    // usort 関数を使用して配列を降順にソート
    // 比較コールバック関数:
    //   - $a が $b より小さい場合（$b - $a が正の場合）は、$a を $b の後に配置 (降順)
    //   - $a が $b より大きい場合（$b - $a が負の場合）は、$a を $b の前に配置 (降順)
    //   - $a と $b が同じ場合（$b - $a が 0 の場合）は、位置を変更しない
    usort($numbers, function (int $a, int $b): int {
        return $b - $a; // 降順ソート
    });

    echo "ソート後の配列 (降順): ";
    print_r($numbers);
}

// 関数の実行
exampleUsortDescending();

PHPの usort 関数は、ユーザーが独自に定義した比較ルールに基づいて、配列の要素を並べ替えるための関数です。

この関数は主に2つの引数を取ります。第1引数の &$array には、ソートしたい配列を指定します。この引数は参照渡しであるため、関数を実行すると元の配列そのものが直接変更されます。第2引数の $callback には、要素を比較するためのルールを記述した関数（コールバック関数）を指定します。usort 関数自体の戻り値は bool 型で、ソートが成功した場合は true を、失敗した場合は false を返します。

サンプルコードでは、数値の配列を降順（大きい順）にソートしています。その比較ルールは、第2引数に指定されたコールバック関数 function (int $a, int $b): int { return $b - $a; } で定義されています。この関数は、配列の中から2つの要素 $a と $b を受け取り、その差を返します。$b - $a の計算結果が正の値になる場合、$a は $b よりも後ろに配置されます。このロジックにより、値が大きい要素ほど配列の前方に移動するため、結果として配列全体が降順に並べ替えられます。このように usort を使うことで、単純な昇順・降順だけでなく、複雑な条件でのソートも柔軟に実装できます。