配列
PHP の配列は、実際には順番付けられたマップです。マップは型の一種で、 値をキーに関連付けます。 この型は、さまざまな使い道にあわせて最適化されます。 配列としてだけでなく、リスト (ベクター)、 ハッシュテーブル (マップの実装の一つ)、辞書、コレクション、スタック、 キュー等として使用することが可能です。 PHP の配列には他の PHP 配列を値として保持することができるため、 非常に簡単にツリー構造を表現することが可能です。
これらのデータ構造に関する説明は本マニュアルの範囲を超えるので省略しますが、 各々について、少なくとも一つは例を示します。 この分野は広範囲にまたがり、さまざまな文献が存在します。 より詳細な情報については、それらの文献を参照ください。
構文
array() で指定
配列 は、言語に組み込まれた
array() で作成することが可能です。この構造は、
特定の数のカンマで区切られた
キー => 値
の組を引数とします。
array( key => value, key2 => value2, key3 => value3, ... )
最後の要素のあとのカンマは、書いても書かなくてもかまいません。
配列を一行で定義する場合は、ふつうは最後のカンマを省略します。つまり、
array(1, 2)
のほうが
array(1, 2, )
よりおすすめだということです。
しかし複数行で定義する場合は、最後のカンマをつけることが一般的です。
そうしておけば、配列の最後に要素を追加するのが容易になるからです。
注意:
array()
を[]
で置き換えることが出来る、配列の短縮構文も使えます。
例1 シンプルな配列定義
<?php
$array = array(
"foo" => "bar",
"bar" => "foo",
);
// 配列の短縮構文
$array = [
"foo" => "bar",
"bar" => "foo",
];
?>
key は、整数 または 文字列です。 value には任意の型を指定できます。
さらに、次のような key のキャストが発生します。
-
10 進数の int として妥当な形式の String は、
数値の前に
+
記号がついていない限り、 int 型にキャストされます。 つまり、キーに"8"
を指定すると、実際には8
として格納されるということです。一方"08"
はキャストされません。これは十進数として妥当な形式ではないからです。 -
floats もまた int にキャストされます。つまり、
小数部分は切り捨てられるということです。たとえばキーに
8.7
を指定すると、実際には8
として格納されます。 -
bool も int にキャストされます。つまり、
キーに
true
を指定すると実際には1
に格納され、 同様にキーをfalse
とすると実際には0
となります。 -
Null は空文字列にキャストされます。つまり、キーに
null
を指定すると、実際には""
として格納されます。 -
array や object は、キーとして使えません。
キーとして使おうとすると
Illegal offset type
という警告が発生します。
配列の宣言時に同じキーで複数の要素を指定すると、 最後に指定したものがそれまでの値を上書きします。
例2 型のキャストと値の上書きの例
<?php
$array = array(
1 => "a",
"1" => "b",
1.5 => "c",
true => "d",
);
var_dump($array);
?>
上の例の出力は以下となります。
array(1) { [1]=> string(1) "d" }
上の例では、すべてのキーが 1
にキャストされます。
そして後から指定した値がどんどん前の値を上書きしていき、最終的には最後に代入された
"d"
だけが残ります。
PHP においては添字配列と連想配列の間に違いはなく、配列型は 1 つだけで、 同じ配列で整数のインデックスと文字列のインデックスを同時に使えます。
例3 整数と文字列のキーの混在例
<?php
$array = array(
"foo" => "bar",
"bar" => "foo",
100 => -100,
-100 => 100,
);
var_dump($array);
?>
上の例の出力は以下となります。
array(4) { ["foo"]=> string(3) "bar" ["bar"]=> string(3) "foo" [100]=> int(-100) [-100]=> int(100) }
key はオプションです。省略した場合、PHP はこれまでに使われた整数のキーの中で最大のものに 1 を加えた値を使います。
例4 数値添字配列でキーを省略する例
<?php
$array = array("foo", "bar", "hello", "world");
var_dump($array);
?>
上の例の出力は以下となります。
array(4) { [0]=> string(3) "foo" [1]=> string(3) "bar" [2]=> string(5) "hello" [3]=> string(5) "world" }
一部の要素にだけキーを指定することもできます。
例5 一部の要素にだけキーを指定する例
<?php
$array = array(
"a",
"b",
6 => "c",
"d",
);
var_dump($array);
?>
上の例の出力は以下となります。
array(4) { [0]=> string(1) "a" [1]=> string(1) "b" [6]=> string(1) "c" [7]=> string(1) "d" }
ごらんの通り、最後の値である "d"
のキーは
7
となります。それまでにキーとして使われた最大の整数が
6
だからです。
例6 複雑な型のキャストと上書きの例
以下の例は、型のキャストされた時と、要素が上書きされる時の全ての場合を示しています。
<?php
$array = array(
1 => 'a',
'1' => 'b', // 値 "a" は "b" で上書きされます。
1.5 => 'c', // 値 "b" は "c" で上書きされます。
-1 => 'd',
'01' => 'e', // この値は数値文字列ではないので、キー1を上書きしません
'1.5' => 'f', // この値は数値文字列ではないので、キー1を上書きしません
true => 'g', // 値 "c" は "g" で上書きされます。
false => 'h',
'' => 'i',
null => 'j', // 値 "i" は "j" で上書きされます。
'k', // 値 "k" にはキー2が割り当てられます。なぜなら、これより前のキーの最大値は1だからです。
2 => 'l', // 値 "k" は "l" で上書きされます。
);
var_dump($array);
?>
上の例の出力は以下となります。
array(7) { [1]=> string(1) "g" [-1]=> string(1) "d" ["01"]=> string(1) "e" ["1.5"]=> string(1) "f" [0]=> string(1) "h" [""]=> string(1) "j" [2]=> string(1) "l" }
角括弧構文による配列要素へのアクセス
配列の要素へのアクセスには array[key]
構文を使います。
例7 配列の要素へのアクセス
<?php
$array = array(
"foo" => "bar",
42 => 24,
"multi" => array(
"dimensional" => array(
"array" => "foo"
)
)
);
var_dump($array["foo"]);
var_dump($array[42]);
var_dump($array["multi"]["dimensional"]["array"]);
?>
上の例の出力は以下となります。
string(3) "bar" int(24) string(3) "foo"
注意:
PHP 8.0.0 より前のバージョンでは、 配列の要素にアクセスするときに、 角括弧と波括弧がどちらも同じ意味で使えていました。 (つまり、この例で
$array[42]
と$array{42}
は同じものを表しているということです)。 波括弧で配列にアクセスする文法は、 PHP 7.4.0 以降は非推奨になり、 PHP 8.0.0 以降はサポートされなくなっています。
例8 配列のデリファレンス
<?php
function getArray() {
return array(1, 2, 3);
}
$secondElement = getArray()[1];
?>
注意:
配列に定義されていないキーへアクセスしたときの挙動は、 未定義の変数にアクセスしたときと同じです。 つまり、
E_WARNING
レベルの警告 (PHP 8.0.0 より前のバージョンではE_NOTICE
) が発生し、結果がnull
になります。
注意:
配列で文字列以外のスカラー値をデリファレンスした場合は、 返される結果は
null
となります。 PHP 7.4.0 より前のバージョンでは、何もエラーは発生しませんでした。 PHP 7.4.0 以降では、E_NOTICE
が発生します。 PHP 8.0.0 以降では、E_WARNING
が発生します。
角括弧構文で作成/修正
明示的に値を設定することにより、既存の配列を修正することも可能です。
これは、角括弧の中にキーを指定し、配列に値を代入することにより行います。
キーを省略することも可能です。この場合、空の角括弧
("[]
") の変数名として追加してください。
$arr[キー] = 値; $arr[] = 値; // キー は 文字列 または // 整数のどちらかです。 // 値 の型は、何でもかまいません。
$arr がまだ存在しない場合、
あるいは null
や false
に設定されている場合は、
新しく配列を作成します。
つまり、これは配列を作成する方法のひとつでもあります。
とはいえ、この方法を使うことはおすすめしません。なぜなら、既に
$arr に何らかの値
(リクエスト変数からの文字列など) が入っている場合にはその値がそのまま残り、
[]
が実際には
文字列アクセス演算子
を表してしまうからです。
変数を初期化するときには、直接代入するほうがよいでしょう。
注意: PHP 7.1.0 以降では、文字列に空のインデックス演算子を適用すると fatal エラーが発生するようになりました。 これまでのバージョンではエラーにならず、文字列が配列に変換されていました。
注意: PHP 8.1.0 以降では、
false
に設定している値から新しく配列を作成することは推奨されません。null
や未定義の値から配列を新しく作成することはまだ許可されています。
ある値を変更するには、 新しい値に値を代入します。特定のキー/値の組を削除したい場合には、 unset() を使用する必要があります。
<?php
$arr = array(5 => 1, 12 => 2);
$arr[] = 56; // このスクリプトのこの位置に記述した場合、
// $arr[13] = 56; と同じです
$arr["x"] = 42; // キー"x"の新しい要素を配列に追加します
unset($arr[5]); // 配列から要素を削除します
unset($arr); // 配列全体を削除します
?>
注意:
上記のように、キーを省略して新規要素を追加する場合、 追加される数値添字は、使用されている添字の最大値 +1 (ただし、少なくとも 0 以上) になります。 まだ数値添字が存在しない場合は、添字は
0
(ゼロ) となります。警告PHP 4.3.0 以降、上記のような添字生成動作は変更されました。 現在では、配列に追加する際に、 その配列の最大添字が負である場合は次の添え字はゼロ (
0
) となります。 以前は、正の添字の場合と同様に新しい添字は最大添字に +1 したものがセットされました。次のキー生成において、オフセットとして使われる整数値 (添字の最大値) に対応するエントリーが、 必ずしも配列内に存在するわけではないことに注意してください。 しかし、その値は、多くの場合、 配列にある整数のキー値の最大値と等しいはずです。以下に例を示します。
<?php
// 簡単な配列を生成します。
$array = array(1, 2, 3, 4, 5);
print_r($array);
// 全てのアイテムを削除しますが、配列自体は削除しないでおきます。
foreach ($array as $i => $value) {
unset($array[$i]);
}
print_r($array);
// アイテムを追加します(新しい添え字は0ではなく
// 5となることに注意)
$array[] = 6;
print_r($array);
// 添え字を振りなおします。
$array = array_values($array);
$array[] = 7;
print_r($array);
?>上の例の出力は以下となります。
Array ( [0] => 1 [1] => 2 [2] => 3 [3] => 4 [4] => 5 ) Array ( ) Array ( [5] => 6 ) Array