(PHP 4, PHP 5, PHP 7, PHP 8)
ksort — 配列をキーで昇順にソートする
&$array, int $flags = SORT_REGULAR): bool
array をキーで昇順にソートします。
注意:
比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバージョンでは、ソートした配列におけるそれらの並び順は不定でした。
注意:
この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。
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 を返します。
例1 ksort() の例
<?php
$fruits = array("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple");
ksort($fruits);
foreach ($fruits as $key => $val) {
echo "$key = $val\n";
}
?>
上の例の出力は以下となります。
a = orange b = banana c = apple d = lemon
例2 数値がキーの場合の ksort() の振る舞い
<?php
$a = [0 => 'First', 2 => 'Last', 1 => 'Middle'];
var_dump($a);
ksort($a);
var_dump($a);
?>
上の例の出力は以下となります。
array(3) {
[0]=>
string(5) "First"
[2]=>
string(4) "Last"
[1]=>
string(6) "Middle"
}
array(3) {
[0]=>
string(5) "First"
[1]=>
string(6) "Middle"
[2]=>
string(4) "Last"
}