函数文档

rest_is_ip_address()

💡 云策文档标注

概述

rest_is_ip_address() 是 WordPress REST API 中的一个函数,用于验证 IP 地址的有效性。它支持 IPv4 和 IPv6 地址格式,返回有效的 IP 地址字符串或 false。

关键要点

  • 函数用于验证 IP 地址,处理 IPv4 和 IPv6 两种格式。
  • 参数 $ip 为必需,表示待验证的 IP 地址字符串。
  • 返回值:如果 IP 地址有效,返回原字符串;否则返回 false。
  • 该函数自 WordPress 4.7.0 版本引入。

代码示例

function rest_is_ip_address( $ip ) {
    $ipv4_pattern = '/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/';

    if ( ! preg_match( $ipv4_pattern, $ip ) && ! WpOrgRequestsIpv6::check_ipv6( $ip ) ) {
        return false;
    }

    return $ip;
}

📄 原文内容

Determines if an IP address is valid.

Description

Handles both IPv4 and IPv6 addresses.

Parameters

$ipstringrequired
IP address.

Return

string|false The valid IP address, otherwise false.

Source

function rest_is_ip_address( $ip ) {
	$ipv4_pattern = '/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/';

	if ( ! preg_match( $ipv4_pattern, $ip ) && ! WpOrgRequestsIpv6::check_ipv6( $ip ) ) {
		return false;
	}

	return $ip;
}

Changelog

Version Description
4.7.0 Introduced.