ywork2020.com

Title

配列のキーを取得する

目次 (INDEX)

array_keys とは

ここで説明する array_keys とは次の語句からなる PHP の関数です。
array
読み: アレイ
意味: 配列
key
読み: キー
意味: 鍵、ここでは 配列のキー (添え字) のこと

目次に戻る

array_keys 関数の概要

この関数は、引数に与えた配列のキーを返します。

引数に配列のみを与えた場合、その配列のキーを全て返します。 また、配列と検索値を与えた場合はキーに対応する値を検索値と比較し、マッチしている値のキーのみを返します。

なお、戻り値は配列として返ります。

目次に戻る

構文

サンプルを見る前に構文を確認しておきます。 

$arrKeys = array_keys(arrArray [, mxdSearchValue [, blnStrict]]);
  • $arrKeys: 戻り値となるキーの配列です。
  • arrArray: キーの取得を行う、対象の配列です。
  • mxdSearchValue: キーを検索する場合、この値を含むキーのみを返します。
  • blnStrict: キーを検索する場合、厳密な比較 ( === ) を行うかを真偽値で指定します。既定値は false です。

目次に戻る

サンプルコードと実行結果

ここでは、array_keys() の引数に配列のみを与えた場合と、配列と検索値を与えた場合の 2つのパターンをサンプルとしました。

サンプルコード: HTML ( 拡張子は .php ) 
<body>
<?php
	... 
?>
</body>
  • 02: <?php (php のコードを記述するための開始タグです。)
  • 03: ... (この行は [ サンプルコード: PHP ] の内容の部分です。)
  • 04: ?>(php の記述を終了するための終了タグです。)
  • ここでは HTML ドキュメントの body 要素内に php の開始タグと終了タグを置いていますが、 開始タグと終了タグはドキュメントのどの部分に設置しても構いませんし、ドキュメント内の複数の場所に分けて記述しても問題ありません。 また、HTML ドキュメントとしてではなく、純粋に php のコードのみを記述しても構いません。 ただし、どの記述方法であろうともファイルの拡張子は .php であることが必要です。
サンプルコード: PHP 
<?php
	$arrArray = ["ywork", "2020", "color"=>"blue", "bgColor"=>"blue"];
	$arrAllKeys = array_keys($arrArray);
	$arrBlueKeys = array_keys($arrArray, "blue");
	print_r($arrAllKeys);
	echo("<hr>");
	print_r($arrBlueKeys);
?>
  • 02: $arrArray (この配列のキーを取得します。)
  • 03: $arrAllKeys (この配列には $arrArray の全てのキーが代入されます。)
  • 04: $arrBlueKeys (この配列には $arrArray の要素が "blue" のキーのみが代入されます。)
  • 05: print_r($arrAllKeys) ($arrAllKeys の内容を print_r() を使って読みやすく表示します。)
  • 07: print_r($arrBlueKeys) ($arrBlueKeys の内容を print_r() を使って読みやすく表示します。)
実行結果:
Array ( [0] => 0 [1] => 1 [2] => color [3] => bgColor )
Array ( [0] => color [1] => bgColor )

目次に戻る