filter_input_array

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

filter_input_array — 取得外部變數並選擇性地過濾它們

說明

filter_input_array(int $type, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null

這個函式可用於擷取多個值，而無需重複呼叫 filter_input()。

參數

type: INPUT_* 常數之一。
警告
正在被過濾的超全域變數的內容是由 SAPI 提供的原始「未經處理」內容，在使用者對超全域變數進行任何修改之前。要過濾已修改的超全域變數，請改用 filter_var_array()。
options: 可以是選項的關聯式陣列，或是要套用至每個項目的過濾器，可以使用 FILTER_VALIDATE_* 常數之一進行驗證過濾，或使用 FILTER_SANITIZE_* 常數之一進行消毒過濾。選項陣列是一個關聯式陣列，其中鍵對應於資料 陣列 中的鍵，而關聯的值是要套用至此項目的過濾器，或是一個描述如何以及應套用哪個過濾器至此項目的關聯式陣列。描述如何套用過濾器的關聯式陣列必須包含 'filter' 鍵，其關聯的值是要套用的過濾器，可以是 FILTER_VALIDATE_*、FILTER_SANITIZE_*、FILTER_UNSAFE_RAW 或 FILTER_CALLBACK 常數之一。它可以選擇性地包含 'flags' 鍵，指定套用於過濾器的旗標，以及 'options' 鍵，指定套用於過濾器的任何選項。
add_empty: 將缺少的鍵值以 null 加入到回傳值中。

回傳值

成功時，會回傳一個包含所請求變數值的陣列。

失敗時，會回傳 false。但如果失敗是因為 type 指定的輸入陣列未填入，則如果使用 FILTER_NULL_ON_FAILURE 旗標，則會回傳 null。

如果 add_empty 為 **true**，則輸入陣列中缺少的項目將會被填入返回的陣列中。在這種情況下，缺少的項目將被設為 **null**，除非使用了 **FILTER_NULL_ON_FAILURE** 旗標，此時它會是 **false**。

如果過濾失敗，返回的陣列的項目將會是 **false**，除非使用了 **FILTER_NULL_ON_FAILURE** 旗標，此時它會是 **null**。

注意事項

注意:
**INPUT_SERVER** 陣列中沒有 REQUEST_TIME 鍵，因為它稍後會被插入到 $_SERVER 中。

另請參閱

filter_input() - 取得指定名稱的外部變數，並可選擇性地進行過濾
filter_var() - 使用指定的過濾器過濾變數
filter_var_array() - 取得多個變數，並可選擇性地進行過濾
驗證過濾器 FILTER_VALIDATE_*
淨化過濾器 FILTER_SANITIZE_*

發現問題了嗎？

瞭解如何改進此頁面 • 提交 Pull Request • 回報錯誤

＋新增註解

使用者貢獻的註解 9 則註解

向上

向下

sdupuis at blax dot ca ¶

10 年前

請注意，雖然您可以為整個輸入陣列提供預設過濾器，但若不自行建構整個定義陣列，就無法為該過濾器提供旗標。

因此，這裡有一個小函式可以減輕這個麻煩！

<?php
函式 filter_input_array_with_default_flags($type, $filter, $flags, $add_empty = true) {
 $loopThrough = array();
 switch ($type) {
 case INPUT_GET : $loopThrough = $_GET; break;
 case INPUT_POST : $loopThrough = $_POST; break;
 case INPUT_COOKIE : $loopThrough = $_COOKIE; break;
 case INPUT_SERVER : $loopThrough = $_SERVER; break;
 case INPUT_ENV : $loopThrough = $_ENV; break;
 }
 
 $args = array();
 foreach ($loopThrough as $key=>$value) {
 $args[$key] = array('filter'=>$filter, 'flags'=>$flags);
 }
 
 return filter_input_array($type, $args, $add_empty);
}
?>

向上

向下

CertaiN ¶

10 年前

[新版本]
這個函式對於過濾複雜的陣列結構非常有用。
此外，也支援一些整數位元遮罩和無效 UTF-8 序列的偵測。

程式碼
<?php
/**
 * @param integer $type Constant like INPUT_XXX.
 * @param array $default Default structure of the specified super global var.
 * Following bitmasks are available:
 * + FILTER_STRUCT_FORCE_ARRAY - Force 1 dimensional array.
 * + FILTER_STRUCT_TRIM - Trim by ASCII control chars.
 * + FILTER_STRUCT_FULL_TRIM - Trim by ASCII control chars,
 * full-width and no-break space.
 * @return array The value of the filtered super global var.
 */
define('FILTER_STRUCT_FORCE_ARRAY', 1);
define('FILTER_STRUCT_TRIM', 2);
define('FILTER_STRUCT_FULL_TRIM', 4);
function filter_struct_utf8($type, array $default) {
 static $func = __FUNCTION__;
 static $trim = "[\\x0-\x20\x7f]";
 static $ftrim = "[\\x0-\x20\x7f\xc2\xa0\xe3\x80\x80]";
 static $recursive_static = false;
 if (!$recursive = $recursive_static) {
 $types = array(
 INPUT_GET => $_GET,
 INPUT_POST => $_POST,
 INPUT_COOKIE => $_COOKIE,
 INPUT_REQUEST => $_REQUEST,
 );
 if (!isset($types[(int)$type])) {
 throw new LogicException('unknown super global var type');
 }
 $var = $types[(int)$type];
 $recursive_static = true;
 } else {
 $var = $type;
 }
 $ret = array();
 foreach ($default as $key => $value) {
 if ($is_int = is_int($value)) {
 if (!($value | (
 FILTER_STRUCT_FORCE_ARRAY |
 FILTER_STRUCT_FULL_TRIM | 
 FILTER_STRUCT_TRIM
 ))) {
 $recursive_static = false;
 throw new LogicException('unknown bitmask');
 }
 if ($value & FILTER_STRUCT_FORCE_ARRAY) {
 $tmp = array();
 if (isset($var[$key])) {
 foreach ((array)$var[$key] as $k => $v) {
 if (!preg_match('//u', $k)){
 continue;
 }
 $value &= FILTER_STRUCT_FULL_TRIM | FILTER_STRUCT_TRIM;
 $tmp += array($k => $value ? $value : '');
 }
 }
 $value = $tmp;
 }
 }
 if ($isset = isset($var[$key]) and is_array($value)) {
 $ret[$key] = $func($var[$key], $value);
 } elseif (!$isset || is_array($var[$key])) {
 $ret[$key] = null;
 } elseif ($is_int && $value & FILTER_STRUCT_FULL_TRIM) {
 $ret[$key] = preg_replace("/\A{$ftrim}++|{$ftrim}++\z/u", '', $var[$key]);
 } elseif ($is_int && $value & FILTER_STRUCT_TRIM) {
 $ret[$key] = preg_replace("/\A{$trim}++|{$trim}++\z/u", '', $var[$key]);
 } else {
 $ret[$key] = preg_replace('//u', '', $var[$key]);
 }
 if ($ret[$key] === null) {
 $ret[$key] = $is_int ? '' : $value;
 }
 }
 if (!$recursive) {
 $recursive_static = false;
 }
 return $ret;
}
?>

向上

向下

CertaiN ¶

11 年前

這個函式對於過濾複雜的陣列結構非常有用。

程式碼
<?php
函式 filter_request($var, $default_structure) {

 $ret = array();

 foreach ($default_structure as $key => $value) {
 if (!isset($var[$key])) {
 $ret[$key] = $value;
 } elseif (is_array($value)) {
 $ret[$key] = filter_request($var[$key], $value);
 } elseif (is_array($var[$key])) {
 $ret[$key] = $value;
 } else {
 $ret[$key] = $var[$key];
 }
 }

 return $ret;

}
?>

範例用法
<?php
$_GET['a']['wrong_structure'] = 'foo';
$_GET['b']['c'] = 'CORRECT';
$_GET['b']['d']['wrong_structure'] = 'bar';
$_GET['unneeded_item'] = 'baz';

var_dump(filter_request($_GET, array(
 'a' => 'DEFAULT',
 'b' => array(
 'c' => 'DEFAULT',
 'd' => 'DEFAULT',
 ),
)));
?>

範例結果
array(2) {
["a"]=>
string(21) "DEFAULT"
["b"]=>
array(2) {
["c"]=>
string(12) "CORRECT"
["d"]=>
string(21) "DEFAULT"
  }
}

向上

向下

匿名 ¶

14 年前

注意：如果沒有設定任何參數，這個函式會返回 NULL，而不是一個包含 NULL 值的陣列。

/* 請求中沒有設定任何 POST 變數 */
$_POST = array();
*/

$args = array('some_post_var' => FILTER_VALIDATE_INT);
$myinputs = filter_input_array(INPUT_POST, $args);
var_dump($myinputs);

預期輸出：array(1) { ["some_post_var"]=> NULL }

實際輸出：NULL

向上

向下

Kevin ¶

16 年前

看起來 filter_input_array 並未察覺在呼叫 filter_input_array 之前對輸入陣列所做的更改。 相反地，它總是查看最初提交的輸入陣列。

所以這樣做不會成功

$_POST['my_float_field'] = str_replace(',','.',$_POST['my_float_field']);
$args = array('my_float_field',FILTER_VALIDATE_FLOAT);
$result = filter_input_array(INPUT_POST, $args);

向上

向下

CertaiN ¶

10 年前

[新版本]

使用範例
<?php
$_GET['A']['a'] = ' CORRECT(including some spaces) ';
$_GET['A']['b'] = ' CORRECT(including some spaces) ';
$_GET['A']['c'] = "Invalid UTF-8 sequence: \xe3\xe3\xe3";
$_GET['A']['d']['invalid_structure'] = 'INVALID';

$_GET['B']['a'] = ' CORRECT(including some spaces) ';
$_GET['B']['b'] = "Invalid UTF-8 sequence: \xe3\xe3\xe3";
$_GET['B']['c']['invalid_structure'] = 'INVALID';
$_GET['B']["Invalid UTF-8 sequence: \xe3\xe3\xe3"] = 'INVALID';

$_GET['C']['a'] = ' CORRECT(including some spaces) ';
$_GET['C']['b'] = "Invalid UTF-8 sequence: \xe3\xe3\xe3";
$_GET['C']['c']['invalid_structure'] = 'INVALID';
$_GET['C']["Invalid UTF-8 sequence: \xe3\xe3\xe3"] = 'INVALID';

$_GET['unneeded_item'] = 'UNNEEDED';

var_dump(filter_struct_utf8(INPUT_GET, array(
 'A' => array(
 'a' => '',
 'b' => FILTER_STRUCT_TRIM,
 'c' => '',
 'd' => '',
 ),
 'B' => FILTER_STRUCT_FORCE_ARRAY,
 'C' => FILTER_STRUCT_FORCE_ARRAY | FILTER_STRUCT_TRIM,
)));
?>

範例結果
array(3) {
["A"]=>
array(4) {
["a"]=>
string(36) " CORRECT(including some spaces) "
["b"]=>
字串(30) "CORRECT(包含一些空格)"
["c"]=>
字串(0) ""
["d"]=>
字串(0) ""
  }
["B"]=>
array(3) {
["a"]=>
string(36) " CORRECT(including some spaces) "
["b"]=>
字串(0) ""
["c"]=>
字串(0) ""
  }
["C"]=>
array(3) {
["a"]=>
字串(30) "CORRECT(包含一些空格)"
["b"]=>
字串(0) ""
["c"]=>
字串(0) ""
  }
}

向上

向下

ville at N0SPAM dot zydo dot com ¶

14 年前

在過濾輸入陣列時，除了 FILTER_REQUIRE_ARRAY 之外，請小心設定的標記。例如，像這樣設定標記


<?php 
$filter = array( 
'myInputArr' => array('filter' => FILTER_SANITIZE_STRING, 
 'flags' => array('FILTER_FLAG_STRIP_LOW', 'FILTER_REQUIRE_ARRAY')) 
); 
 
$form_inputs = filter_input_array(INPUT_POST, $filter); 
?> 

.. 將導致 $form_inputs['myInputArr'] 為空，無論 $_POST['myInputArr'] 包含什麼。

向上

向下

kibblewhite at live dot com ¶

15 年前

如果您嘗試處理多個同名的表單輸入，則必須將 `'flags' => FILTER_REQUIRE_ARRAY` 分配給定義項目。

例如，您有一個如下所示的 HTML 表單
<form>
<input name="t1[]" value="Some string One" />
<input name="t1[]" value="Another String Two" />
</form>

您的定義陣列看起來會像這樣
$args = array(
't1' => array(
'name' => 't1',
'filter' => FILTER_SANITIZE_STRING,
'flags' => FILTER_REQUIRE_ARRAY)
);

向上

向下

cornelyu85 at yahoo dot com ¶

1 年前

這是一個擴展函數，允許您保留請求中未過濾的項目/參數，同時還可以對其中一些應用驗證

<?php

$validationRules = [
 'foo' => [
 'filter' => FILTER_VALIDATE_REGEXP,
 'options' => ['regexp' => '/^(bar|baz)$/i']
 ]
];

$request = filter_input_array_keep_unfiltered_args(INPUT_POST, $validationRules);

var_dump($request);

function filter_input_array_keep_unfiltered_args($type, $filters, $addEmpty = true)
{
 $rawRequest = filter_input_array($type);

 $validationRules = [];
 foreach ($rawRequest as $key => $value) {
 $validationRules[$key] = isset($filters[$key]) ? $filters[$key] : ['filter' => FILTER_DEFAULT];
 }

 return filter_input_array($type, $validationRules, $addEmpty);
}

?>

＋新增註解