sort

(PHP 4, PHP 5, PHP 7)

sort — 配列をソートする

説明

sort ( array &$array [, int $sort_flags = SORT_REGULAR ] ) : bool

この関数は配列をソートします。この関数が正常に終了すると、 各要素が小さい順に並び変わった状態になります。

注意:

比較結果が等しくなる二つの要素があった場合、ソートした配列におけるそれらの並び順は不定となります。

パラメータ

array

入力の配列。

sort_flags

オプションの 2 番目のパラメータ sort_flags は、以下の値によりソートの動作を修正するために使用することが可能です。

ソート型のフラグ:

  • SORT_REGULAR - 通常通りに項目を比較 (型は変更しません)
  • SORT_NUMERIC - 数値的に項目を比較
  • SORT_STRING - 文字列として項目を比較
  • SORT_LOCALE_STRING - は、現在のロケールに基づいて比較します。 比較に使うロケールは、setlocale() で変更できます。
  • SORT_NATURAL - 要素の比較を文字列として行い、 natsort() と同様の「自然順」で比較します。
  • SORT_FLAG_CASE - SORT_STRING や SORT_NATURAL と (ビット OR で) 組み合わせて使い、 文字列のソートで大文字小文字を区別しないようにします。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

変更履歴

バージョン 説明
5.4.0 sort_flags に SORT_NATURAL と SORT_FLAG_CASE が使えるようになりました。
5.0.2 SORT_LOCALE_STRING が追加されました。

例

例1 sort() の例

<?php

$fruits = array("lemon", "orange", "banana", "apple");
sort($fruits);
foreach ($fruits as $key => $val) {
    echo "fruits[" . $key . "] = " . $val . "\n";
}

?>

上の例の出力は以下となります。

fruits[0] = apple
fruits[1] = banana
fruits[2] = lemon
fruits[3] = orange

fruits はアルファベットの昇順にソートされました。

例2 sort() で、大文字小文字を区別せずに自然順での並べ替えを行う例

<?php

$fruits = array(
    "Orange1", "orange2", "Orange3", "orange20"
);
sort($fruits, SORT_NATURAL | SORT_FLAG_CASE);
foreach ($fruits as $key => $val) {
    echo "fruits[" . $key . "] = " . $val . "\n";
}

?>

上の例の出力は以下となります。

fruits[0] = Orange1
fruits[1] = orange2
fruits[2] = Orange3
fruits[3] = orange20

fruits が natcasesort() と同じようにソートされました。

注意

注意: この関数は、 array パラメータの要素に対して新しいキーを割り当てます。 その際、単純にキーを並べ替える代わりに、 すでに割り当てられている既存のキーを削除してしまいます。

注意: PHP の大半のソート関数と同様、sort() は » Quicksort でそれを実装しています。 ピボットは、既にソート済みの部分に対して時間的に最適なところを選択します。 しかしこれはあくまでも内部の実装の話なので、これに依存したコードを書いてはいけません。

警告

複数の型が混在する配列をソートする場合には、注意してください。 sort() が予測不可能な結果を出力することがあります。

参考