rest_find_matching_pattern_property_schema( string $property, array $args ): array|null

Parameters

$propertystring

The property name to check.

$argsarray

The schema array to use.

Return

array|null

The schema of matching pattern property, or null if no patterns match.

Uses · 1

• rest_validate_json_schema_pattern()Validates if the JSON Schema pattern matches a value.

Used by · 3

• rest_filter_response_by_context()Filters the response to remove any fields not available in the given context.
• rest_sanitize_value_from_schema()Sanitize a value based on a schema.
• rest_validate_object_value_from_schema()Validates an object value based on a schema.

Source

View on Trac ↗View on GitHub ↗

1804function rest_find_matching_pattern_property_schema( $property, $args ) {1805	if ( isset( $args['patternProperties'] ) ) {1806		foreach ( $args['patternProperties'] as $pattern => $child_schema ) {1807			if ( rest_validate_json_schema_pattern( $pattern, $property ) ) {1808				return $child_schema;1809			}1810		}1811	}1812 1813	return null;1814}

History

Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.