(PHP 4, PHP 5, PHP 7, PHP 8)
arsort — 連想キーと要素との関係を維持しつつ配列を逆順にソートする
&$array
, int $flags
= SORT_REGULAR
) : boolこの関数は、連想配列において各配列のキーと要素との関係を維持しつつソートを行います。
この関数は、主に実際の要素の並び方が重要である連想配列をソートするために使われます。
注意:
比較結果が等しくなる二つの要素があった場合、ソートした配列におけるそれらの並び順は不定となります。
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
を、失敗した場合に false
を返します。
例1 arsort() の例
<?php
$fruits = array("d" => "lemon", "a" => "orange", "b" => "banana", "c" => "apple");
arsort($fruits);
foreach ($fruits as $key => $val) {
echo "$key = $val\n";
}
?>
上の例の出力は以下となります。
a = orange d = lemon b = banana c = apple
fruits はアルファベットの逆順にソートされ、 各要素とキーとの関係は維持されます。