SYNCER

SYNCER

array_diff_key() - 配列のキーの差異を確認する

公開日:

array_diff_keyは、配列のキーの差異を調べる関数です。一方にあって一方にないキーを確認できます。比較は、(string)$a===(string)$bで行われます。例えば、数値の1と文字列の"1"は同じになります。多次元配列の場合、一次元のみが比較されます。

構文

array array_diff_key ( array $array1 , array $array2 [, array $... ] )

パラメータ

$array1

基本の配列。

$array2

比較対象となる配列。

$...

比較対象となる配列は1つだけじゃなく、第3引数以降で指定できる。

返り値

array

第1引数の配列にはあって、第2引数以降に指定した配列にはないキーの要素を集めた配列。

サンプルコード

キーの差異を確認する

第1引数で指定した基本の配列にはあって、第2引数にはないキーを調べます。第1引数と第2引数を入れ替えると違う結果になります。

php

<?php
	// 配列
	$queue1 = [
		"a" => 1 ,
		"b" => 2 ,
		"c" => 3 ,
	] ;

	$queue2 = [
		"a" => 11 ,
		"b" => 12 ,
	] ;

	// 実行
	$result = array_diff_key( $queue1, $queue2 ) ;

	// 返り値
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.21

Array
(
    [c] => 3
)

第3引数以降を指定する

比較対象となる配列は1つだけではなく、第3引数以降で複数指定できます。第2引数以降の全ての配列のキーが比較対象となります。

php

<?php
	// 配列
	$queue1 = [
		"a" => 1 ,
		"b" => 2 ,
		"c" => 3 ,
	] ;

	$queue2 = [
		"a" => 11 ,
	] ;

	$queue3 = [
		"b" => 12 ,
	] ;

	// 実行
	$result = array_diff_key( $queue1, $queue2, $queue3 ) ;

	// 返り値
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.21

Array
(
    [c] => 3
)

比較方法

比較方法は(string)$a===(string)$bで行われます。なので、文字列に型変換して同じになる値は、同じものと判定されます。

php

<?php
	// 配列
	$queue1 = [
		"1" => "赤" ,
		"2" => "白" ,
		"3" => "黒" ,
	] ;

	$queue2 = [
		1 => "緑" ,
		2 => "紫" ,
	] ;

	// 実行
	$result = array_diff_key( $queue1, $queue2 ) ;

	// 返り値
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.21

Array
(
    [3] => 黒
)

サンドボックス

ソースコードを編集してarray_diff_key()の挙動を確認して下さい。

Array
(
    [c] => 3
)

参考リンク

  • PHP - 公式マニュアル。