配列を昇順にソートする

# sort

(PHP 4, PHP 5, PHP 7, PHP 8)

sort — 配列を昇順にソートする

### 説明

function sort(array `&$array`, int `$flags` = `SORT_REGULAR`): true

`array` を値で昇順にソートします。

> 注意: 比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバージョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

> 注意: この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

### パラメータ

`array`

  入力の配列。

`flags`
  オプションの第二引数 `flags` によりソートの動作を修正可能です。 使える値は下記の通りです:

  ソートタイプのフラグ:

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

### 戻り値

常に `true` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.2.0 | 戻り値の型が、`true` になりました。これより前のバージョンでは、bool でした。

### 例

例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() と同じようにソートされました。

### 注意

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

警告

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

### 参考

- rsort() - 配列を降順にソートする
- 配列ソート関数の比較

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open