【PHP8.x】EXTR_SKIP定数の使い方
EXTR_SKIP定数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
EXTR_SKIP定数は、PHPのextract()関数で使用される動作モードの一つを表す定数です。extract()関数は、連想配列のキーを変数名として、その値を現在のスコープにインポートする際に用いることができます。例えば、['name' => 'John', 'age' => 30]という配列がある場合、extract()を実行すると$name = 'John';、$age = 30;のような変数が作成されます。
ここで、EXTR_SKIP定数をextract()関数の第二引数に指定すると、配列からインポートしようとしている変数名が、既に現在のスコープに同じ名前で存在する場合、その既存の変数の値は上書きされず、新しい変数のインポートは行われません。つまり、既存の変数が優先され、配列からの値は無視されます。
この定数は、特に外部からの入力データを含む配列をextract()する際に、システム内部で既に定義されている重要な変数を誤って上書きしてしまうリスクを避けるために役立ちます。これにより、予期せぬデータの破壊やバグの発生を防ぎ、プログラムの堅牢性を高めることができます。extract()関数にはEXTR_OVERWRITE（常に上書き）、EXTR_PREFIX_ALL（全ての変数にプレフィックスを付与）など、他にも複数の動作モードが用意されており、用途に応じて適切なモードを選択することが重要です。EXTR_SKIPは、既存の変数の安全性を確保しつつ、配列の内容を変数として展開したい場合に選択されるべきオプションです。
構文(syntax)
1<?php 2$data = ['username' => 'alice']; 3$username = 'guest'; 4extract($data, EXTR_SKIP); 5?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
EXTR_SKIP は、extract() 関数と共に使用される定数で、連想配列から変数を展開する際に、既に同名の変数が存在する場合はそれを上書きしないように指定するために使用されます。この定数は整数値 1 を返します。
サンプルコード
PHP extract EXTR_SKIPで既存変数上書きをスキップする
1<?php 2 3/** 4 * EXTR_SKIP フラグを使用して extract() 関数の動作を示すサンプルコードです。 5 * 6 * extract() 関数は、連想配列のキーを変数名、値をその変数の値としてインポートします。 7 * EXTR_SKIP フラグを使用すると、同じ名前の変数が既に存在する場合、その変数の上書きをスキップします。 8 */ 9 10// サンプルデータとなる連想配列を定義します。 11$userData = [ 12 'username' => 'alice_smith', 13 'email' => 'alice@example.com', 14 'status' => 'active', 15]; 16 17// extract() を呼び出す前に、配列のキーと同じ名前の変数を宣言し、初期値を設定します。 18// これらの変数が extract() によって上書きされるかどうかを確認します。 19$username = 'initial_user'; // 'username' は $userData にも存在する 20$email = 'initial@example.com'; // 'email' も $userData に存在する 21// 'status' は宣言しないでおき、新しく作成されることを示します。 22 23echo "--- extract() 実行前 ---" . PHP_EOL; 24echo "username: " . ($username ?? '未定義') . PHP_EOL; 25echo "email: " . ($email ?? '未定義') . PHP_EOL; 26echo "status: " . ($status ?? '未定義') . PHP_EOL . PHP_EOL; 27 28// EXTR_SKIP フラグを使用して extract() 関数を呼び出します。 29// 既に存在する同名変数 ($username, $email) は上書きされません。 30// 存在しない変数 ($status) は新しく作成されます。 31echo "--- extract(\$userData, EXTR_SKIP) 実行後 ---" . PHP_EOL; 32extract($userData, EXTR_SKIP); 33 34// 変数の値を出力し、EXTR_SKIP フラグの効果を確認します。 35// $username と $email は元の値のまま ('initial_user', 'initial@example.com')。 36// $status は新しく作成され、配列の値 ('active') が設定されます。 37echo "username: " . ($username ?? '未定義') . PHP_EOL; // initial_user のまま 38echo "email: " . ($email ?? '未定義') . PHP_EOL; // initial@example.com のまま 39echo "status: " . ($status ?? '未定義') . PHP_EOL . PHP_EOL; // active が設定される 40 41?>
PHP 8で利用可能なEXTR_SKIPは、主にextract()関数と組み合わせて使用される定数です。extract()関数は、連想配列のキーを変数名、その値を対応する変数の値として、現在のスコープにインポートする機能を持っています。
EXTR_SKIP定数をextract()関数の第二引数に指定することで、変数のインポート挙動を制御できます。具体的には、インポートしようとしている配列のキーと同じ名前の変数が、すでに現在のスコープに存在していた場合、EXTR_SKIPはその既存の変数を上書きする処理をスキップします。これにより、既存の変数の値が意図せず変更されるのを防ぐことができます。
サンプルコードでは、$userData配列のキーであるusernameとemailが、extract()関数を呼び出す前に変数として宣言されています。EXTR_SKIPを指定してextract()を実行すると、これらの既存の$usernameと$email変数は、$userData配列の値で上書きされずに、元の値が保持されます。一方、$userData配列に存在するstatusは、事前に宣言されていなかったため、extract()によって新しく作成され、配列の値が設定されます。
EXTR_SKIP定数自体には引数はなく、内部的には整数値（int型）として定義されています。この定数を利用することで、変数名の衝突を避けつつ、配列のデータを効率的に変数として扱えるようになります。
extract()関数は、連想配列のキーから変数名を生成するため、特にユーザー入力など信頼できないデータに使用すると、意図しない変数名の作成や既存の変数の上書き（このサンプルコードではEXTR_SKIPで回避されていますが、他のフラグでは発生します）といったセキュリティ上のリスク（変数汚染攻撃など）があります。EXTR_SKIPフラグは既存変数との衝突を避けますが、それでも新しい変数がスクリプト内に多数生成される可能性に注意が必要です。開発時にはどの変数がどこで定義され、どのように値が設定されるかを明確に把握することが重要です。一般的に、extract()の使用は避け、必要な値は配列から直接アクセスするか、個別に変数に代入する方法がより安全で推奨されます。