Latest web development tutorials

PHP extract() 函數

PHP Array Reference 完整的PHP Array參考手冊

實例

將鍵值"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() 函數從數組中將變量導入到當前的符號表。

該函數使用數組鍵名作為變量名,使用數組鍵值作為變量值。 針對數組中的每個元素,將在當前符號表中創建對應的一個變量。

該函數返回成功設置的變量數目。


語法

extract( array,extract_rules,prefix )

参数 描述
array 必需。规定要使用的数组。
extract_rules 可选。extract() 函数将检查每个键名是否为合法的变量名,同时也检查和符号表中已存在的变量名是否冲突。对不合法和冲突的键名的处理将根据此参数决定。

可能的值:

  • EXTR_OVERWRITE - 默认。如果有冲突,则覆盖已有的变量。
  • EXTR_SKIP - 如果有冲突,不覆盖已有的变量。
  • EXTR_PREFIX_SAME - 如果有冲突,在变量名前加上前缀 prefix。
  • EXTR_PREFIX_ALL - 给所有变量名加上前缀 prefix。
  • EXTR_PREFIX_INVALID - 仅在不合法或数字变量名前加上前缀 prefix。
  • EXTR_IF_EXISTS - 仅在当前符号表中已有同名变量时,覆盖它们的值。其它的都不处理。
  • EXTR_PREFIX_IF_EXISTS - 仅在当前符号表中已有同名变量时,建立附加了前缀的变量名,其它的都不处理。
  • EXTR_REFS - 将变量作为引用提取。导入的变量仍然引用了数组参数的值。
prefix 可选。如果 extract_rules 参数的值是 EXTR_PREFIX_SAME、EXTR_PREFIX_ALL、 EXTR_PREFIX_INVALID 或 EXTR_PREFIX_IF_EXISTS,则 prefix 是必需的。

该参数规定了前缀。前缀和数组键名之间会自动加上一个下划线。

技術細節

返回值: 返回成功設置的變量數目。
PHP 版本: 4+
更新日誌: extract_rules的值EXTR_REFS是在PHP 4.3中新增的。

extract_rules的值EXTR_IF_EXISTS和EXTR_PREFIX_IF_EXISTS是在PHP 4.2中新增的。

自PHP 4.0.5 起,該函數返回成功設置的變量數目。

extract_rules的值EXTR_PREFIX_INVALID是在PHP 4.0.5中新增的。

自PHP 4.0.5起, extract_rules的值EXTR_PREFIX_ALL也包含數字變量。


更多實例

實例1

使用所有的參數:

<?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 Array Reference 完整的PHP Array參考手冊