wpseek.com
Eine auf WordPress spezialiserte Suchmaschine für Entwickler und Theme-Autoren
_wp_prepare_json_schema_for_client_with_allowed_keywords is private and should not be used in themes or plugins directly.
_wp_prepare_json_schema_for_client_with_allowed_keywords › WordPress Function
Seit7.1.0
Veraltetn/v
› _wp_prepare_json_schema_for_client_with_allowed_keywords ( $schema, $allowed_keywords )
| Zugriff: |
|
| Parameter: (2) |
|
| Gibt zurück: |
|
| Definiert in: |
|
| Codex: |
Prepares a JSON Schema for clients using a given keyword lookup.
Quellcode
function _wp_prepare_json_schema_for_client_with_allowed_keywords( array $schema, array $allowed_keywords ): array {
if ( isset( $schema['type'] ) && 'object' === $schema['type'] && isset( $schema['default'] ) ) {
$default = $schema['default'];
if ( is_array( $default ) && empty( $default ) ) {
$schema['default'] = (object) $default;
}
}
$schema = array_intersect_key( $schema, $allowed_keywords );
/*
* Collect draft-03 per-property `required: true` flags into a draft-04
* `required` array of property names on the parent object schema.
*
* This mirrors rest_validate_object_value_from_schema(), where a draft-04
* `required` array takes precedence: when one is present, per-property
* booleans are ignored during validation. They are therefore left out of
* the array here as well (but still stripped from the output) so the
* published schema describes exactly what gets enforced.
*/
if ( isset( $schema['properties'] ) && is_array( $schema['properties'] ) ) {
$has_required_array = isset( $schema['required'] ) && is_array( $schema['required'] );
$required = array();
foreach ( $schema['properties'] as $property => &$property_schema ) {
if ( is_array( $property_schema ) && ! wp_is_numeric_array( $property_schema ) && isset( $property_schema['required'] ) && is_bool( $property_schema['required'] ) ) {
if ( ! $has_required_array && true === $property_schema['required'] ) {
$required[] = (string) $property;
}
unset( $property_schema['required'] );
}
}
unset( $property_schema );
/*
* Property keys are unique, so the collected list needs no deduplication.
* When a draft-04 array is already present, leave it untouched.
*/
if ( ! $has_required_array && count( $required ) > 0 ) {
$schema['required'] = $required;
}
}
/*
* A boolean `required` outside of an object's property list has no draft-04
* equivalent, so drop it rather than emit an invalid keyword.
*/
if ( isset( $schema['required'] ) && is_bool( $schema['required'] ) ) {
unset( $schema['required'] );
}
/*
* Sub-schema maps: keys are user-defined, values are sub-schemas.
* Note: 'dependencies' values can also be property-dependency arrays
* (numeric arrays of strings) which are skipped via wp_is_numeric_array().
*/
foreach ( array( 'properties', 'patternProperties', 'definitions', 'dependencies' ) as $keyword ) {
if ( isset( $schema[ $keyword ] ) && is_array( $schema[ $keyword ] ) ) {
foreach ( $schema[ $keyword ] as $key => $child_schema ) {
if ( is_array( $child_schema ) && ! wp_is_numeric_array( $child_schema ) ) {
$schema[ $keyword ][ $key ] = _wp_prepare_json_schema_for_client_with_allowed_keywords( $child_schema, $allowed_keywords );
}
}
}
}
// Single sub-schema keywords.
foreach ( array( 'not', 'additionalProperties', 'additionalItems' ) as $keyword ) {
if ( isset( $schema[ $keyword ] ) && is_array( $schema[ $keyword ] ) && ! wp_is_numeric_array( $schema[ $keyword ] ) ) {
$schema[ $keyword ] = _wp_prepare_json_schema_for_client_with_allowed_keywords( $schema[ $keyword ], $allowed_keywords );
}
}
// Items: single schema or tuple array of schemas.
if ( isset( $schema['items'] ) && is_array( $schema['items'] ) ) {
if ( ! wp_is_numeric_array( $schema['items'] ) ) {
$schema['items'] = _wp_prepare_json_schema_for_client_with_allowed_keywords( $schema['items'], $allowed_keywords );
} else {
foreach ( $schema['items'] as $index => $item_schema ) {
if ( is_array( $item_schema ) && ! wp_is_numeric_array( $item_schema ) ) {
$schema['items'][ $index ] = _wp_prepare_json_schema_for_client_with_allowed_keywords( $item_schema, $allowed_keywords );
}
}
}
}
// Array-of-schemas keywords.
foreach ( array( 'anyOf', 'oneOf', 'allOf' ) as $keyword ) {
if ( isset( $schema[ $keyword ] ) && is_array( $schema[ $keyword ] ) ) {
foreach ( $schema[ $keyword ] as $index => $sub_schema ) {
if ( is_array( $sub_schema ) && ! wp_is_numeric_array( $sub_schema ) ) {
$schema[ $keyword ][ $index ] = _wp_prepare_json_schema_for_client_with_allowed_keywords( $sub_schema, $allowed_keywords );
}
}
}
}
return $schema;
}