PHP extract()関数

例

値「Cat」、「Dog」、および「Horse」を変数$a、$b、および$cに割り当てます。

<?php
$a = "Original";
$my_array = array("a" => "Cat","b" => "Dog", "c" => "Horse");
extract($my_array);
echo "\$a = $a; \$b = $b; \$c = $c";
?>

定義と使用法

extract()関数は、変数を配列からローカルシンボルテーブルにインポートします。

この関数は、配列キーを変数名として使用し、値を変数値として使用します。要素ごとに、現在のシンボルテーブルに変数が作成されます。

この関数は、成功時に抽出された変数の数を返します。

構文

<div>extract(<em>array, extract_rules, prefix</em>)</div>

パラメータ値

パラメータ説明

array Required 使用する配列を指定します

extract_rules Optional extract()関数は、無効な変数名と既存の変数名との衝突をチェックします。このパラメーターは、無効で衝突する名前の処理方法を指定します。
可能な値:

EXTR_OVERWRITE - デフォルト。衝突すると、既存の変数が上書きされます

EXTR_SKIP - 衝突時に、既存の変数は上書きされません

EXTR_PREFIX_SAME - 衝突時に、変数名に接頭辞が付けられます

EXTR_PREFIX_ALL - すべての変数名にプレフィックスが付けられます

EXTR_PREFIX_INVALID - 無効または数値の変数名のみに接頭辞が付けられます

EXTR_IF_EXISTS - 現在のシンボルテーブルの既存の変数のみを上書きし、それ以外の場合は何もしません

EXTR_PREFIX_IF_EXISTS - 同じ変数が現在のシンボルテーブルに存在する場合にのみ、変数にプレフィックスを追加します

EXTR_REFS - 参照として変数を抽出します。インポートされた変数はまだ配列パラメータの値を参照しています

prefix Optional EXTR_PREFIX_SAME、EXTR_PREFIX_ALL、EXTR_PREFIX_INVALID、または EXTR_PREFIX_IF_EXISTSがextract_rulesパラメーターで使用されている場合、指定されたプレフィックスが必要です。

このパラメータはプレフィックスを指定します。プレフィックスは、アンダースコア文字によって配列キーから自動的に分離されます。

パラメータ	説明
array	Required 使用する配列を指定します
extract_rules	Optional extract()関数は、無効な変数名と既存の変数名との衝突をチェックします。このパラメーターは、無効で衝突する名前の処理方法を指定します。可能な値: EXTR_OVERWRITE - デフォルト。衝突すると、既存の変数が上書きされます EXTR_SKIP - 衝突時に、既存の変数は上書きされません EXTR_PREFIX_SAME - 衝突時に、変数名に接頭辞が付けられます EXTR_PREFIX_ALL - すべての変数名にプレフィックスが付けられます EXTR_PREFIX_INVALID - 無効または数値の変数名のみに接頭辞が付けられます EXTR_IF_EXISTS - 現在のシンボルテーブルの既存の変数のみを上書きし、それ以外の場合は何もしません EXTR_PREFIX_IF_EXISTS - 同じ変数が現在のシンボルテーブルに存在する場合にのみ、変数にプレフィックスを追加します EXTR_REFS - 参照として変数を抽出します。インポートされた変数はまだ配列パラメータの値を参照しています
prefix	Optional EXTR_PREFIX_SAME、EXTR_PREFIX_ALL、EXTR_PREFIX_INVALID、または EXTR_PREFIX_IF_EXISTSがextract_rulesパラメーターで使用されている場合、指定されたプレフィックスが必要です。このパラメータはプレフィックスを指定します。プレフィックスは、アンダースコア文字によって配列キーから自動的に分離されます。

Technical Detail

Return Value: 成功時に抽出された変数の数を返します

PHP バージョン: 4+

PHP 変更ログ:
PHP4.3でextract_rulesにEXTR_REFSが追加されました。

PHP4.2でextract_rulesにEXTR_IF_EXISTSおよびEXTR_PREFIX_IF_EXISTSが追加されました。

PHP4.0.5以降、この関数は抽出された変数の数を返すようになりました。

PHP4.0.5でextract_rulesにEXTR_PREFIX_INVALIDが追加されました。

PHP4.0.5以降、extract_rulesの値にEXTR_PREFIX_ALLに、数値変数も含まれるようになりました。

Return Value:	成功時に抽出された変数の数を返します
PHP バージョン:	4+
PHP 変更ログ:	PHP4.3でextract_rulesにEXTR_REFSが追加されました。 PHP4.2でextract_rulesにEXTR_IF_EXISTSおよびEXTR_PREFIX_IF_EXISTSが追加されました。 PHP4.0.5以降、この関数は抽出された変数の数を返すようになりました。 PHP4.0.5でextract_rulesにEXTR_PREFIX_INVALIDが追加されました。 PHP4.0.5以降、extract_rulesの値にEXTR_PREFIX_ALLに、数値変数も含まれるようになりました。

その他の例

例

すべてのパラメータを使用:

<?php
$a = "Original";
$my_array = array("a" => "Cat", "b" => "Dog", "c" => "Horse");
    
extract($my_array, EXTR_PREFIX_SAME, "dup");
    
echo "\$a = $a; \$b = $b; \$c = $c; \$dup_a = $dup_a";
?>

❮ PHP 配列リファレンス