PHPの配列のソート：sort()、usort()、asort()、ksort()

sort($array)は配列をその場で昇順に並べ替えます。渡した変数を変更してtrueを返すので、単独の行で呼び出してから配列を使います。rsort()は降順に並べ替えます。

<?php
$numbers = [42, 7, 19, 3, 25];
sort($numbers);
print_r($numbers);

$fruits = ["pear", "apple", "fig", "banana"];
rsort($fruits);
print_r($fruits);

PHPには、「値かキーか」「昇順か降順か」「キーを保つかどうか」の組み合わせごとにソート関数があります。

連想配列を値で並べ替える

連想配列にsort()を使うとキーが消えます。値で並べ替えて各キーを値と結びつけたまま保つにはasort()を、大きい順ならarsort()を使います。

<?php
$scores = ["Ada" => 92, "Bob" => 67, "Cy" => 85, "Dee" => 74];

$copy = $scores;
sort($copy);
print_r($copy); // names are gone

arsort($scores);
print_r($scores); // highest first, names kept

echo "Winner: " . array_key_first($scores) . "\n";

ksortで配列をキーで並べ替える

ksort()はキーの順に、krsort()はキーの逆順に並べます。設定を出力したり、クエリ文字列を一定の順番で組み立てたりする前に便利です。

<?php
$params = ["page" => 2, "category" => "books", "author" => "le guin", "sort" => "year"];

ksort($params);
print_r($params);

echo http_build_query($params), "\n";

usortと宇宙船演算子で独自の順番にする

usort($array, $callback)を使えば順番を自分で決められます。コールバックは2つの要素を受け取り、1つ目を先にするなら負の数、2つ目を先にするなら正の数、等しければ0を返します。宇宙船演算子<=>はまさにそれを返します。

<?php
$words = ["banana", "fig", "cherry", "kiwi", "apple"];

// Shortest first
usort($words, fn($a, $b) => strlen($a) <=> strlen($b));
print_r($words);

// Longest first: swap $a and $b
usort($words, fn($a, $b) => strlen($b) <=> strlen($a));
print_r($words);

bananaとcherryは同じ長さなので、コールバックは0を返し、すでにあった順番のままになります。PHPのソートはPHP 8.0以降安定で、等しい要素は前の順番を保ちます。

多次元配列を値で並べ替える

行のリストを1つのフィールドで並べ替えるには、usortでそのフィールドを比較します。2つのフィールドで並べ替えるには配列を比較します。<=>は要素ごとに比較するので、2つ目のフィールドは1つ目が同じときだけ順番を決めます。

<?php
$people = [
    ["name" => "Ada", "city" => "London", "age" => 36],
    ["name" => "Linus", "city" => "Helsinki", "age" => 28],
    ["name" => "Grace", "city" => "New York", "age" => 45],
    ["name" => "Alan", "city" => "London", "age" => 41],
];

// By age, youngest first
usort($people, fn($a, $b) => $a["age"] <=> $b["age"]);
echo implode(", ", array_column($people, "name")), "\n";

// By city, then oldest first within a city
usort($people, fn($a, $b) =>
    [$a["city"], $b["age"]] <=> [$b["city"], $a["age"]]
);
foreach ($people as $p) {
    echo "{$p['city']}: {$p['name']} ({$p['age']})\n";
}

2つ目の比較では、$b["age"]を左側に、$a["age"]を右側に置いているので、年齢の順番だけが逆になります。array_multisort(array_column($people, 'city'), SORT_ASC, array_column($people, 'age'), SORT_DESC, $people)でも、コールバックなしで同じ順番になります。取り出した列で並べ替え、それに合わせて$peopleを並べ直すのです。

自然順とソートフラグ

デフォルトでは、PHPは数値を数値として、文字列を文字列として比較します。数字を含むファイル名は、人が予想しない順番に並びます。img10がimg2より前に来て、大文字の名前がすべて小文字の名前より前に来ます。フラグで値の比較方法を変えられます。

<?php
$files = ["img12.png", "img10.png", "img2.png", "IMG1.png"];

$plain = $files;
sort($plain);
print_r($plain);

$natural = $files;
sort($natural, SORT_NATURAL | SORT_FLAG_CASE);
print_r($natural);

$mixed = ["10", "9", "2", "1"];
sort($mixed, SORT_STRING);
print_r($mixed);

SORT_NATURALは連続した数字を数値として読み、SORT_FLAG_CASEは大文字小文字を無視し、SORT_STRINGは数値の文字列でも1文字ずつの比較を強制します。natsort()とnatcasesort()は同じ考え方で、キーを保ちます。

よくあるミス：sortの結果を代入する

すべてのソート関数はtrueを返し、渡した配列を変更します。戻り値を代入すると配列を失います。

<?php
$list = [3, 1, 2];

$sorted = sort($list);
var_dump($sorted); // bool(true), not an array
print_r($list);    // this is the sorted array

元の配列を残したまま並べ替えたコピーが必要なら、上のasortの例で$copyを使っているように、先に配列を新しい変数にコピーしてからコピーを並べ替えます。