« ArrayIterator::key
ArrayIterator::natcasesort »

ArrayIterator::ksort

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

ArrayIterator::ksort — キーで配列をソートする

説明

public function ArrayIterator::ksort(int $flags = SORT_REGULAR): true

キーで配列をソートします。

注意:

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

パラメータ

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 でした。

参考

関連キーワード:
ソート   ArrayIterator   キー   ksort   項目   flags   自然   natcasesort   並び順   ロケール   natsort   大文字   小文字   区別   保持   不定   修正   下記   タイプ   フラグ   通常   詳細   演算子   数値   setlocale
関連する関数・ページ:
arrayiterator.asort   arrayiterator.natsort   arrayiterator.natcasesort   arrayiterator.uksort   arrayiterator.uasort   class.arrayiterator