2024年PHP日本大会

预定义常量

以下常量由此扩展定义,只有在将扩展编译到PHP中或在运行时动态加载时才可用。

输入常量

这些常量由 filter_input()filter_input_array() 使用。

INPUT_POST (int)
POST 变量。
INPUT_GET (int)
GET 变量。
COOKIE 变量。
INPUT_ENV (int)
ENV 变量。
INPUT_SERVER (int)
SERVER 变量。
INPUT_SESSION (int)
SESSION 变量。(从PHP 8.0.0开始移除;之前未实现)
INPUT_REQUEST (int)
REQUEST 变量。(从PHP 8.0.0开始移除;之前未实现)
通用过滤器标志
FILTER_FLAG_NONE (int)
无标志。
FILTER_REQUIRE_SCALAR (int)
用于要求过滤器的输入为标量的标志。
FILTER_REQUIRE_ARRAY (int)
用于要求过滤器的输入为 array 的标志。
FILTER_FORCE_ARRAY (int)
此标志将标量输入包装到一个元素 array 中,用于对数组进行操作的过滤器。
FILTER_NULL_ON_FAILURE (int)
使用 null 代替 false 表示失败。 可与任何验证 FILTER_VALIDATE_* 过滤器一起使用。
清理过滤器标志
FILTER_FLAG_STRIP_LOW (int)
去除ASCII值小于32的字符。
FILTER_FLAG_STRIP_HIGH (int)
去除ASCII值大于127的字符。
FILTER_FLAG_STRIP_BACKTICK (int)
去除反引号(`)字符。
FILTER_FLAG_ENCODE_LOW (int)
编码ASCII值小于32的字符。
FILTER_FLAG_ENCODE_HIGH (int)
编码ASCII值大于127的字符。
FILTER_FLAG_ENCODE_AMP (int)
编码 &
FILTER_FLAG_NO_ENCODE_QUOTES (int)
单引号和双引号('")不会被编码。
FILTER_FLAG_EMPTY_STRING_NULL (int)
如果清理字符串结果为空字符串,则将值转换为 null
验证过滤器
FILTER_VALIDATE_BOOL (int)
"1""true""on""yes" 返回 true "0""false""off""no""" 返回 false 非布尔值的返回值取决于 FILTER_NULL_ON_FAILURE。如果设置了它,则返回 null,否则返回 false
可用选项
默认值
过滤器失败时返回的值。
从PHP 8.0.0开始可用。
FILTER_VALIDATE_BOOLEAN (int)
FILTER_VALIDATE_BOOL 的别名。此别名在PHP 8.0.0引入其规范名称之前可用。
FILTER_VALIDATE_INT (int)
验证值是否为整数,成功后将其转换为 int 类型。

注意: 在验证之前,使用 trim() 修剪字符串值。

可用选项
默认值
过滤器失败时返回的值。
最小范围
仅当值大于或等于提供的值时,值才有效。
最大范围
仅当值小于或等于提供的值时,值才有效。
可选标志
FILTER_FLAG_ALLOW_OCTAL (int)
允许八进制表示的整数(0[0-7]+)。
FILTER_FLAG_ALLOW_HEX (int)
允许十六进制表示的整数(0x[0-9a-fA-F]+)。
FILTER_VALIDATE_FLOAT (int)
验证值是否为浮点数,成功则转换为 float 类型。

注意: 在验证之前,使用 trim() 修剪字符串值。

可用选项
默认值
过滤器失败时返回的值。
十进制
最小范围
仅当值大于或等于提供的值时才有效。PHP 7.4.0 版起可用。
最大范围
仅当值小于或等于提供的值时才有效。PHP 7.4.0 版起可用。
可选标志
FILTER_FLAG_ALLOW_THOUSAND (int)
接受逗号 (,),通常表示千位分隔符。
FILTER_VALIDATE_REGEXP (int)
根据 regexp 选项提供的正则表达式验证值。
可用选项
默认值
过滤器失败时返回的值。
正则表达式
Perl 兼容型 正则表达式。
FILTER_VALIDATE_URL (int)
根据 » RFC 2396 验证 URL 名称是否有效。
可用选项
默认值
过滤器失败时返回的值。
可选标志
FILTER_FLAG_SCHEME_REQUIRED (int)
要求 URL 包含方案部分。
警告

自 PHP 7.3.0 起已弃用,自 PHP 8.0.0 起已移除。这是因为它总是由 FILTER_VALIDATE_URL 过滤器隐含。

FILTER_FLAG_HOST_REQUIRED (int)
要求 URL 包含主机部分。
警告

自 PHP 7.3.0 起已弃用,自 PHP 8.0.0 起已移除。这是因为它总是由 FILTER_VALIDATE_URL 过滤器隐含。

FILTER_FLAG_PATH_REQUIRED (int)
要求 URL 包含路径部分。
FILTER_FLAG_QUERY_REQUIRED (int)
要求 URL 包含查询部分。
警告

有效的 URL 可能不会指定 HTTP 协议 (http://)。因此,可能需要进一步验证以确定 URL 是否使用预期的协议,例如 ssh://mailto:

警告

此过滤器仅适用于 ASCII URL。这意味着国际化域名 (IDN) 将始终被拒绝。

FILTER_VALIDATE_DOMAIN (int)
根据 » RFC 952» RFC 1034» RFC 1035» RFC 1123» RFC 2732» RFC 2181 验证域名是否有效。
可用选项
默认值
过滤器失败时返回的值。
可选标志
FILTER_FLAG_HOSTNAME (int)
要求主机名以字母数字字符开头,并且仅包含字母数字字符或连字符。
FILTER_VALIDATE_EMAIL (int)
验证值是否为“有效”电子邮件地址。 根据 » RFC 822 中的 addr-spec 语法执行验证。但是,不支持注释、空格折叠和无点域名,因此将被拒绝。
可用选项
默认值
过滤器失败时返回的值。
可选标志
FILTER_FLAG_EMAIL_UNICODE (int)
接受本地部分中的 Unicode 字符。PHP 7.1.0 版起可用。
警告

电子邮件验证很复杂,确认电子邮件有效且存在的唯一真正方法是向该地址发送电子邮件。

FILTER_VALIDATE_IP (int)

将值验证为 IP 地址。

可用选项
默认值
过滤器失败时返回的值。
可选标志
FILTER_FLAG_IPV4 (int)
允许 IPv4 地址。
FILTER_FLAG_IPV6 (int)
允许 IPv6 地址。
FILTER_FLAG_NO_RES_RANGE (int)
拒绝保留地址。 这些是在 » RFC 6890 中标记为 Reserved-By-Protocol 的范围。

对于 IPv4,对应于以下范围:0.0.0.0/8169.254.0.0/16127.0.0.0/8240.0.0.0/4

对于 IPv6,对应于以下范围:::1/128::/128::FFFF:0:0/96FE80::/10

FILTER_FLAG_NO_PRIV_RANGE (int)
拒绝专用地址。

这些是位于以下范围内的 IPv4 地址:10.0.0.0/8172.16.0.0/12192.168.0.0/16

这些是以 FDFC 开头的 IPv6 地址。
FILTER_FLAG_GLOBAL_RANGE (int)
仅允许全局地址。这些可以在 » RFC 6890 中找到,其中 Global 属性为 True。PHP 8.2.0 版起可用。
FILTER_VALIDATE_MAC (int)
验证值是否为 MAC 地址。
可用选项
默认值
过滤器失败时返回的值。
过滤器的清理
FILTER_UNSAFE_RAW (int)
此过滤器不执行任何操作。 但是,如果与 FILTER_FLAG_STRIP_*FILTER_FLAG_ENCODE_* 过滤器清理标志一起使用,它可以去除或编码特殊字符。
FILTER_DEFAULT (int)
FILTER_UNSAFE_RAW 的别名。
FILTER_SANITIZE_STRING (int)
此过滤器去除标签并 HTML 编码双引号和单引号。 如果与 FILTER_FLAG_STRIP_*FILTER_FLAG_ENCODE_* 过滤器清理标志一起使用,则可以选择去除或编码指定的字符。 可以使用 FILTER_FLAG_NO_ENCODE_QUOTES 过滤器标志禁用编码引号的行为。
警告

自 PHP 8.1.0 起已弃用,请改用 htmlspecialchars()

警告

此过滤器去除标签的方式与 strip_tags() 不等效。

FILTER_SANITIZE_STRIPPED (int)
FILTER_SANITIZE_STRING 的别名。
警告

自 PHP 8.1.0 起已弃用,请改用 htmlspecialchars()

FILTER_SANITIZE_ENCODED (int)
此过滤器 URL 编码字符串。 如果与 FILTER_FLAG_STRIP_*FILTER_FLAG_ENCODE_* 过滤器清理标志一起使用,则可以选择去除或编码指定的字符。
FILTER_SANITIZE_SPECIAL_CHARS (int)

此过滤器 HTML 编码 '"<>& 和 ASCII 值小于 32 的字符。

如果与 FILTER_FLAG_STRIP_* 过滤器清理标志一起使用,则可以选择去除指定的字符,并且可以使用 FILTER_FLAG_ENCODE_HIGH 编码 ASCII 值大于 127 的字符。
FILTER_SANITIZE_FULL_SPECIAL_CHARS (int)
此过滤器等效于使用 ENT_QUOTES 调用 htmlspecialchars() 可以使用 FILTER_FLAG_NO_ENCODE_QUOTES 过滤器标志禁用编码引号的行为。
警告

htmlspecialchars() 一样,此过滤器知道 default_charset INI 设置。如果检测到构成当前字符集中无效字符的字节序列,则整个字符串将被拒绝,结果返回空字符串。

FILTER_SANITIZE_EMAIL (int)
通过去除除拉丁字母 ([a-zA-Z])、数字 ([0-9]) 和特殊字符 !#$%&'*+-=?^_`{|}~@.[] 之外的所有字符来清理字符串。
FILTER_SANITIZE_URL (int)
通过去除除拉丁字母 ([a-zA-Z])、数字 ([0-9]) 和特殊字符 $-_.+!*'(),{}|\\^~[]`<>#%";/?:@&= 之外的所有字符来清理字符串。
FILTER_SANITIZE_NUMBER_INT (int)
通过去除除数字 ([0-9])、加号 (+) 和减号 (-) 之外的所有字符来清理字符串。
FILTER_SANITIZE_NUMBER_FLOAT (int)
通过去除除数字 ([0-9])、加号 (+) 和减号 (-) 之外的所有字符来清理字符串。
可选标志
FILTER_FLAG_ALLOW_FRACTION (int)
接受点 (.) 字符,通常表示整数和小数部分之间的分隔符。
FILTER_FLAG_ALLOW_THOUSAND (int)
接受逗号 (,) 字符,通常表示千位分隔符。
FILTER_FLAG_ALLOW_SCIENTIFIC (int)
通过允许eE字符来接受科学计数法表示的数字。
警告

如果不使用FILTER_FLAG_ALLOW_FRACTION标志,则小数点分隔符将被移除,从而改变接收到的值。

<?php
$number
= '12.34';

var_dump(filter_var($number, FILTER_SANITIZE_NUMBER_FLOAT));
var_dump(filter_var($number, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION));
?>

以上示例将输出

string(4) "1234"
string(5) "12.34"
FILTER_SANITIZE_ADD_SLASHES (int)
addslashes()应用于输入。从 PHP 7.3.0 开始可用。
FILTER_SANITIZE_MAGIC_QUOTES (int)
FILTER_SANITIZE_ADD_SLASHES 的别名。
警告

从 PHP 7.3.0 开始已弃用,从 PHP 8.0.0 开始已移除

用户自定义过滤器
FILTER_CALLBACK (int)
此过滤器将过滤委托给用户定义的函数。callable 通过options参数作为与'options'键关联的值传递。

回调函数应具有以下签名

callback(string $value): mixed
正在过滤的值。

注意: 回调函数返回的值将是调用的过滤器函数返回的值。

示例 #1 使用FILTER_CALLBACK验证登录名

<?php
function validate_login($value): ?string
{
if (
strlen($value) >= 5 && ctype_alnum($value)) {
return
$value;
}
return
null;
}

$login = "val1dL0gin";
$filtered_login = filter_var($login, FILTER_CALLBACK, ['options' => 'validate_login']);
var_dump($filtered_login);

$login = "f&ke login";
$filtered_login = filter_var($login, FILTER_CALLBACK, ['options' => 'validate_login']);
var_dump($filtered_login);
?>

以上示例将输出

string(10) "val1dL0gin"
NULL
警告

此过滤器不能与任何其他过滤器标志一起使用,例如FILTER_NULL_ON_FAILURE

添加注释

用户贡献的注释 1 条注释

shaman_master at list dot ru
4 年前
注意:FILTER_NULL_ON_FAILURE、FILTER_REQUIRE_SCALAR、FILTER_REQUIRE_ARRAY 和 FILTER_FORCE_ARRAY 没有前缀“FILTER_FLAG_”,但它们是标志!
To Top