【PHP8.x】EXTR_IF_EXISTS定数の使い方

EXTR_IF_EXISTS定数は、PHPのextract()関数が配列のキーを現在のスコープの変数として展開する際の挙動を制御するための定数です。

extract()関数は、連想配列のキーを変数名とし、そのキーに対応する値をその変数の値として現在のスコープにインポートする機能を持っています。例えば、['name' => 'John']という配列をextract()すると、$nameという変数が作成され、その値は'John'になります。

このEXTR_IF_EXISTS定数をextract()関数の第二引数に指定した場合、配列のキーと同じ名前の変数が現在のスコープに既に存在する場合にのみ、その変数の値が配列の値で上書きされます。もし配列のキーと同じ名前の変数が現在のスコープに存在しない場合は、その変数がいまだに作成されていなければ、extract()関数はその変数を新しく作成することはなく、何の影響も与えません。

これは、既存の特定の変数のみを配列の値で更新したい場合や、意図しない新しい変数の作成を防ぎたい場合に非常に有用です。既存の変数の状態を尊重しつつ、必要な情報だけを更新するための安全な方法として利用されます。システム開発において変数の意図しない作成や上書きはバグの原因となることが多いため、この定数を適切に利用することで、コードの安全性と予測可能性を高めることができます。

Copy
1<?php
2$existing_variable = 'initial_value';
3$data_array = [
4    'existing_variable' => 'overwritten_value',
5    'new_variable' => 'value_not_created'
6];
7
8// 配列から変数をインポートする際、
9// シンボルテーブルに同名の変数が既に存在する場合のみ上書きします。
10// 存在しない変数は新しく作成されません。
11extract($data_array, EXTR_IF_EXISTS);
12?>

引数なし

引数はありません

int

この定数は、array_filter() 関数などで、指定したキーが存在する場合にのみ、そのキーと値のペアを抽出することを示す整数値です。