函数文档

rest_validate_json_schema_pattern()

💡 云策文档标注

概述

rest_validate_json_schema_pattern() 是一个 WordPress REST API 函数,用于验证 JSON Schema 模式是否匹配给定值。它基于正则表达式进行模式匹配,返回布尔结果。

关键要点

  • 函数用途:验证 JSON Schema 模式与值的匹配性。
  • 参数:$pattern(必需,字符串,要匹配的模式)和 $value(必需,字符串,要检查的值)。
  • 返回值:布尔值,匹配返回 true,否则返回 false。
  • 内部实现:使用 preg_match() 进行正则匹配,并对模式中的 '#' 字符进行转义处理。
  • 相关函数:rest_validate_string_value_from_schema() 和 rest_find_matching_pattern_property_schema()。
  • 引入版本:WordPress 5.6.0。

代码示例

function rest_validate_json_schema_pattern( $pattern, $value ) {
    $escaped_pattern = str_replace( '#', '#', $pattern );
    return 1 === preg_match( '#' . $escaped_pattern . '#u', $value );
}

📄 原文内容

Validates if the JSON Schema pattern matches a value.

Parameters

$patternstringrequired
The pattern to match against.
$valuestringrequired
The value to check.

Return

bool True if the pattern matches the given value, false otherwise.

Source

function rest_validate_json_schema_pattern( $pattern, $value ) {
	$escaped_pattern = str_replace( '#', '\#', $pattern );

	return 1 === preg_match( '#' . $escaped_pattern . '#u', $value );
}

Changelog

Version Description
5.6.0 Introduced.