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

<?php

/**
 * PHPのsort関数を使用して配列の値を昇順にソートし、キーがどのように扱われるかを示すサンプルコードです。
 *
 * sort関数は配列の値をソートしますが、キーの扱いに特徴があります。
 * ・元の数値キーは破棄され、ソートされた値に対して新しいゼロベースの数値キーが再割り当てされます。
 * ・元の文字列キーを持つ要素は、ソート後に完全に削除されます。
 * そのため、キーと値の関連性を維持したい場合は、sort関数ではなくasort関数などを検討する必要があります。
 */
function demonstratePhpSortKeyBehavior(): void
{
    // 数値キーと文字列キーが混在する配列を準備します。
    // 値はソートされるとわかりやすいように文字列にしています。
    $data = [
        'apple_key'  => 'apple',
        0            => 'orange', // 元の数値キー0
        'banana_key' => 'banana',
        1            => 'grape',  // 元の数値キー1
        'kiwi_key'   => 'kiwi',
    ];

    echo "--- ソート前の配列の状態 ---\n";
    echo "（キーと値の関連性にご注目ください）\n";
    print_r($data);

    // sort関数を呼び出して配列をソートします。
    // デフォルトの挙動（SORT_REGULAR）で値を昇順にソートします。
    $success = sort($data);

    if ($success) {
        echo "\n--- ソート後の配列の状態 ---\n";
        echo "（sort関数は値を基準に昇順ソートし、キーが以下のように変更されました。）\n";
        echo "・元の数値キーは破棄され、新しいゼロベースの数値キーが割り当てられました。\n";
        echo "・元の文字列キーを持つ要素は削除されました。\n";
        print_r($data);
    } else {
        echo "\n配列のソートに失敗しました。\n";
    }
}

// 関数の実行
demonstratePhpSortKeyBehavior();

PHPのsort関数は、配列の値を昇順に並べ替えるための基本的な機能を提供します。この関数は、第一引数で渡された配列そのものを直接変更する「参照渡し」という方法で動作し、ソートが成功したか失敗したかを真偽値で返します。第二引数にはソート方法を指定するフラグを渡すことができますが、デフォルトでは標準的な比較が行われます。

特に重要なのは、ソート後の配列における「キー」の扱いです。sort関数は、配列の値に基づいて昇順に並べ替えますが、元のキーの関連性は保持しません。具体的には、ソート後の配列には新しいゼロから始まる数値キーが割り当て直されます。さらに、ソート前の配列に存在していた文字列キーを持つ要素は、ソートが実行されると完全に削除されます。

このため、元の配列のキーと値の関連性を維持したままソートを行いたい場合には、sort関数ではなく、asort関数などキーを保持する他のソート関数を検討する必要があります。サンプルコードは、数値キーと文字列キーが混在する配列をsort関数で処理した際に、これらのキーがどのように扱われるかを具体的に示しています。ソート前とソート後の配列の状態を比較することで、sort関数の独特なキー処理の挙動を理解することができます。

<?php

/**
 * PHPの`sort`関数が連想配列にどのように作用するかを示すサンプルコード。
 * `sort`関数は配列の値を昇順にソートしますが、連想配列の場合、
 * 元のキーは失われ、新しい数値キー(0, 1, 2...)が割り当てられます。
 *
 * @return void
 */
function demonstrateSortWithAssociativeArray(): void
{
    // ソート対象の連想配列を準備します。
    // キーは文字列、値は数値です。
    $data = [
        'apple' => 3,
        'banana' => 1,
        'orange' => 2,
        'grape' => 4,
    ];

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

    // `sort`関数を呼び出し、配列をその値に基づいてソートします。
    // 第1引数: ソートする配列への参照 (`&$array`)
    // 第2引数: ソートフラグ (ここではデフォルトの`SORT_REGULAR`を明示的に指定)
    // この関数は配列自体を変更し、成功したかどうかの`bool`を返します。
    $success = sort($data, SORT_REGULAR);

    echo PHP_EOL . "--- ソート後 ---" . PHP_EOL;
    print_r($data);

    if (!$success) {
        echo "エラー: 配列のソートに失敗しました。" . PHP_EOL;
    }

    echo PHP_EOL;
    echo "補足: `sort()`関数を連想配列に使用すると、値でソートされますが、" . PHP_EOL;
    echo "元のキーは失われ、数値キーに再割り当てされます。" . PHP_EOL;
    echo "連想配列のキーを保持したまま値でソートしたい場合は `asort()` を、" . PHP_EOL;
    echo "キーでソートしたい場合は `ksort()` を使用してください。" . PHP_EOL;
}

// 関数を実行して動作を確認します。
demonstrateSortWithAssociativeArray();

PHPのsort関数は、配列の要素を昇順に並び替えるために使用されます。このサンプルコードは、sort関数を連想配列に適用した場合の具体的な挙動を示しています。

demonstrateSortWithAssociativeArray関数内では、最初にキーと値を持つ連想配列$dataを準備し、ソート前の状態を表示します。その後、sort($data, SORT_REGULAR)を呼び出して配列をソートします。

sort関数の第一引数&$arrayは、ソート対象の配列そのものを示し、関数内で配列の内容が直接変更されます。第二引数$flagsはソート時の比較方法を指定するオプションで、ここではデフォルトのSORT_REGULARを使用しています。この関数は、ソートが成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。

連想配列にsort関数を適用すると、配列は「値」に基づいて昇順に並び替えられますが、元のキーは破棄され、新たに0, 1, 2...といった数値のキーが自動的に割り当てられます。ソート後の出力では、値が昇順になっているものの、キーが数値に変わっていることが確認できます。

連想配列のキーを保持したまま値でソートしたい場合はasort()関数を、キーに基づいてソートしたい場合はksort()関数を使用するなど、目的に応じて適切な関数を選択することが重要です。