php过滤器用于验证和过滤数据,当数据源包含未知的外部数据时(例如用户通过表单提交的数据)此功能特别有用。php过滤器从PHP 5.2.0开始默认启用过滤器扩展。
过滤器主要两种功能验证和过滤。
1、验证用于检查数据是否符合某些条件。例如,传递FILTER_VALIDATE_EMAIL将确定数据是否为有效的电子邮件地址,但不会更改数据本身。
2、过滤将对数据进行清理,可以通过删除不需要的字符来更改数据。例如,传递FILTER_SANITIZE_EMAIL将删除不适合包含电子邮件地址的字符。也就是说,它不会验证数据。
也可以将验证和过滤一起使用。
过滤器函数
filter_has_var — 检测是否存在指定类型的变量
filter_id — 返回与某个特定名称的过滤器相关联的id
filter_input_array — 获取一系列外部变量,并且可以通过过滤器处理它们
filter_input — 通过名称获取特定的外部变量,并且可以通过过滤器处理它
filter_list — 返回所支持的过滤器列表
filter_var_array — 获取多个变量并且过滤它们
filter_var — 使用特定的过滤器过滤一个变量
filter_has_var
语法说明
filter_has_var ( int $type , string $variable_name ) : bool
参数
type
INPUT_GET、 INPUT_POST、 INPUT_COOKIE、 INPUT_SERVER、 INPUT_ENV 里的其中一个。
variable_name
要检查的变量名。
返回值
成功时返回 TRUE, 或者在失败时返回 FALSE。
if ( !filter_has_var(INPUT_GET, 'email') ) {
echo "Email Not Found";
}else{
echo "Email Found";
}
filter_id
说明
filter_id ( string $filtername ) : int
参数
filtername
待获取的过滤器名称,可以通过filter_list()获取支持的过滤器列表。
返回值
如果获取成功则返回过滤器id,如果过滤器不存在则返回 FALSE 。
示例
<?php
$filters = filter_list();
foreach($filters as $filter_name) {
echo $filter_name .": ".filter_id($filter_name) ."<br>";
}
?>
filter_input_array
说明
filter_input_array ( int $type [, mixed $definition [, bool $add_empty = true ]] ) : mixed
参数
type
INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV之一。
definition
一个定义参数的数组。一个有效的键必须是一个包含变量名的string,一个有效的值要么是一个filter type,或者是一个array 指明了过滤器、标示和选项。如果值是一个数组,那么它的有效的键可以是 filter, 用于指明 filter type,flags 用于指明任何想要用于过滤器的标示,或者 options 用于指明任何想要用于过滤器的选项。 参考下面的例子来更好的理解这段说明。
这个参数也可以是一个filter constant的整数。那么数组中的所有变量都会被这个过滤器所过滤。
add_empty
在返回值中添加 NULL 作为不存在的键。
返回值
如果成功的话返回一个所请求的变量的数组,如果失败的话返回 FALSE 。对于数组的值,如果过滤失败则返回 FALSE ,如果variable_name 不存在的话则返回 NULL 。 如果标示 FILTER_NULL_ON_FAILURE 被使用了,那么当变量不存在时返回 FALSE ,当过滤失败时返回 NULL 。
示例
<?php
error_reporting(E_ALL | E_STRICT);
/* data actually came from POST
$_POST = array(
'product_id' => 'libgd<script>',
'component' => '10',
'versions' => '2.0.33',
'testscalar' => array('2', '23', '10', '12'),
'testarray' => '2',
);
*/
$args = array(
'product_id' => FILTER_SANITIZE_ENCODED,
'component' => array('filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_ARRAY,
'options' => array('min_range' => 1, 'max_range' => 10)
),
'versions' => FILTER_SANITIZE_ENCODED,
'doesnotexist' => FILTER_VALIDATE_INT,
'testscalar' => array(
'filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_SCALAR,
),
'testarray' => array(
'filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_ARRAY,
)
);
$myinputs = filter_input_array(INPUT_POST, $args);
var_dump($myinputs);
echo "\n";
?>
// 输出结果
array(6) {
["product_id"]=>
string(17) "libgd%3Cscript%3E"
["component"]=>
array(1) {
[0]=>
int(10)
}
["versions"]=>
string(6) "2.0.33"
["doesnotexist"]=>
NULL
["testscalar"]=>
bool(false)
["testarray"]=>
array(1) {
[0]=>
int(2)
}
}
filter_input
说明
filter_input ( int $type , string $variable_name [, int $filter = FILTER_DEFAULT [, mixed $options ]] ) : mixed
参数
type
INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER或 INPUT_ENV之一。
variable_name
待获取的变量名。
filter
The ID of the filter to apply. The Types of filters manual page lists the available filters.
If omitted, FILTER_DEFAULT will be used, which is equivalent to FILTER_UNSAFE_RAW. This will result in no filtering taking place by default.
options
一个选项的关联数组,或者按位区分的标示。如果过滤器接受选项,可以通过数组的 "flags" 位去提供这些标示。
返回值
如果成功的话返回所请求的变量。如果过滤失败则返回 FALSE ,如果variable_name 不存在的话则返回 NULL 。 如果标示 FILTER_NULL_ON_FAILURE 被使用了,那么当变量不存在时返回 FALSE ,当过滤失败时返回 NULL 。
示例
<?php
$search_html = filter_input(INPUT_GET, 'search', FILTER_SANITIZE_SPECIAL_CHARS);
$search_url = filter_input(INPUT_GET, 'search', FILTER_SANITIZE_ENCODED);
echo "You have searched for $search_html.\n";
echo "<a href='?search=$search_url'>Search again.</a>";
?>
filter_list
说明
filter_list ( void ) : array
参数
无
返回值
返回一个所支持的过滤器的名称的列表,如果没有这样子的过滤器的话则返回空数组。这个数组的索引不是过滤器id, 你可以通过 filter_id() 去根据名称获取它们。
示例
<?php
print_r(filter_list());
?>
//输出结果
Array
(
[0] => int
[1] => boolean
[2] => float
[3] => validate_regexp
[4] => validate_url
[5] => validate_email
[6] => validate_ip
[7] => string
[8] => stripped
[9] => encoded
[10] => special_chars
[11] => unsafe_raw
[12] => email
[13] => url
[14] => number_int
[15] => number_float
[16] => magic_quotes
[17] => callback
)
filter_var_array
说明
filter_var_array ( array $data [, mixed $definition [, bool $add_empty = true ]] ) : mixed
参数
data
数组,键为字符串,值为待过滤的数据。
definition
一个定义参数的数组。一个有效的键必须是一个包含变量名的string,一个有效的值要么是一个filter type,或者是一个array 指明了过滤器、标示和选项。如果值是一个数组,那么它的有效的键可以是 filter, 用于指明 filter type,flags 用于指明任何想要用于过滤器的标示,或者 options 用于指明任何想要用于过滤器的选项。 参考下面的例子来更好的理解这段说明。
这个参数也可以是一个filter constant的整数。那么数组中的所有值都会被这个过滤器所过滤。
add_empty
在返回值中添加 NULL 作为不存在的键。
返回值
如果成功则返回一个包含所请求变量的数组,或者当失败时返回 FALSE 。 一个数组的值如果过滤失败则为 FALSE ,或者为 NULL 如果变量不存在的话。
示例
<?php
error_reporting(E_ALL | E_STRICT);
$data = array(
'product_id' => 'libgd<script>',
'component' => '10',
'versions' => '2.0.33',
'testscalar' => array('2', '23', '10', '12'),
'testarray' => '2',
);
$args = array(
'product_id' => FILTER_SANITIZE_ENCODED,
'component' => array('filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_FORCE_ARRAY,
'options' => array('min_range' => 1, 'max_range' => 10)
),
'versions' => FILTER_SANITIZE_ENCODED,
'doesnotexist' => FILTER_VALIDATE_INT,
'testscalar' => array(
'filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_SCALAR,
),
'testarray' => array(
'filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_FORCE_ARRAY,
)
);
$myinputs = filter_var_array($data, $args);
var_dump($myinputs);
echo "\n";
?>
filter_var
说明
filter_var ( mixed $variable [, int $filter = FILTER_DEFAULT [, mixed $options ]] ) : mixed
参数
variable
待过滤的变量。注意:标量的值在过滤前,会被转换成字符串。
filter
The ID of the filter to apply. The Types of filters manual page lists the available filters.
If omitted, FILTER_DEFAULT will be used, which is equivalent to FILTER_UNSAFE_RAW. This will result in no filtering taking place by default.
options
一个选项的关联数组,或者按位区分的标示。如果过滤器接受选项,可以通过数组的 "flags" 位去提供这些标示。 对于回调型的过滤器,应该传入 callable。这个回调函数必须接受一个参数,即待过滤的值,并且 返回一个在过滤/净化后的值。
返回值
过滤成功会返回过滤后的数据,失败则返回false
示例
<?php
var_dump(filter_var('bob@example.com', FILTER_VALIDATE_EMAIL));
var_dump(filter_var('http://example.com', FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED));
?>
以上例程会输出:
string(15) "bob@example.com"
bool(false)
预定义常量
INPUT_POST (integer)
POST 变量。
INPUT_GET (integer)
GET 变量。
INPUT_COOKIE (integer)
COOKIE 变量。
INPUT_ENV (integer)
ENV 变量。
INPUT_SERVER (integer)
SERVER 变量。
INPUT_SESSION (integer)
SESSION 变量。 (暂未实现)
INPUT_REQUEST (integer)
REQUEST 变量。 (暂未实现)
FILTER_FLAG_NONE (integer)
没有标记。
FILTER_REQUIRE_SCALAR (integer)
此标记要求输入的是标量。
FILTER_REQUIRE_ARRAY (integer)
需要输入的是数组。
FILTER_FORCE_ARRAY (integer)
一律返回数组。
FILTER_NULL_ON_FAILURE (integer)
失败时返回 NULL,而非 FALSE。
FILTER_VALIDATE_INT (integer)
标记 "int" 过滤器。
FILTER_VALIDATE_BOOLEAN (integer)
标记 "boolean" 过滤器。
FILTER_VALIDATE_FLOAT (integer)
标记 "float" 过滤器。
FILTER_VALIDATE_REGEXP (integer)
标记 "validate_regexp" 过滤器。
FILTER_VALIDATE_URL (integer)
标记 "validate_url" 过滤器。
FILTER_VALIDATE_EMAIL (integer)
标记 "validate_email" 过滤器。
FILTER_VALIDATE_IP (integer)
标记 "validate_ip" 过滤器。
FILTER_VALIDATE_MAC (integer)
标记 "validate_mac_address" 过滤器。(PHP 5.5.0 起有效)
FILTER_DEFAULT (integer)
标记默认的 "unsafe_raw" 过滤器。 等同于 FILTER_UNSAFE_RAW。
FILTER_UNSAFE_RAW (integer)
标记 "unsafe_raw" 过滤器。
FILTER_SANITIZE_STRING (integer)
标记 "string" 过滤器。
FILTER_SANITIZE_STRIPPED (integer)
标记 "stripped" 过滤器。
FILTER_SANITIZE_ENCODED (integer)
标记 "encoded" 过滤器。
FILTER_SANITIZE_SPECIAL_CHARS (integer)
标记 "special_chars" 过滤器。
FILTER_SANITIZE_EMAIL (integer)
标记 "email" 过滤器。
FILTER_SANITIZE_URL (integer)
标记 "url" 过滤器。
FILTER_SANITIZE_NUMBER_INT (integer)
标记 "number_int" 过滤器。
FILTER_SANITIZE_NUMBER_FLOAT (integer)
标记 "number_float" 过滤器。
FILTER_SANITIZE_MAGIC_QUOTES (integer)
标记 "magic_quotes" 过滤器。
FILTER_CALLBACK (integer)
标记 "callback" 过滤器。
FILTER_FLAG_ALLOW_OCTAL (integer)
"int" 过滤器允许八进制(octal)标记的字符(0[0-7]+)。
FILTER_FLAG_ALLOW_HEX (integer)
"int" 过滤器允许十六进制(Hex)标记的字符(0x[0-9a-fA-F]+)
FILTER_FLAG_STRIP_LOW (integer)
过滤 ASCII 编码值大于 32 的字符 。
FILTER_FLAG_STRIP_HIGH (integer)
过滤 ASCII 编码值大于 127 的字符 。
FILTER_FLAG_ENCODE_LOW (integer)
字符的 ASCII 编码值大于 32。
FILTER_FLAG_ENCODE_HIGH (integer)
字符的 ASCII 编码值大于 127。
FILTER_FLAG_ENCODE_AMP (integer)
为 & 编码。
FILTER_FLAG_NO_ENCODE_QUOTES (integer)
不要为 ' 和 " 编码。
FILTER_FLAG_EMPTY_STRING_NULL (integer)
(目前不能使用。)
FILTER_FLAG_ALLOW_FRACTION (integer)
"number_float" 过滤器允许小数部分。
FILTER_FLAG_ALLOW_THOUSAND (integer)
"number_float" 过滤器允许使用千分位分隔符(,)。
FILTER_FLAG_ALLOW_SCIENTIFIC (integer)
"number_float" 过滤器允许使用科学计数法(e、E)。
FILTER_FLAG_PATH_REQUIRED (integer)
"validate_url" 过滤器,要求带路径部分。
FILTER_FLAG_QUERY_REQUIRED (integer)
"validate_url" 过滤器,要求带 Query 部分。
FILTER_FLAG_IPV4 (integer)
"validate_ip" 过滤器,仅仅允许 IPv4 地址。
FILTER_FLAG_IPV6 (integer)
"validate_ip" 过滤器,仅仅允许 IPv6 地址。
FILTER_FLAG_NO_RES_RANGE (integer)
"validate_ip" 过滤器,禁止保留 IP 地址。
FILTER_FLAG_NO_PRIV_RANGE (integer)
"validate_ip" 过滤器,禁止私有 IP 地址。
FILTER_FLAG_EMAIL_UNICODE (integer)
"validate_email" 过滤器,在邮件地址用户名部分允许 Unicode 字符。 (PHP 7.1.0 起有效)