wp_prepare_json_schema_for_client( $schema, string $schema_profile = 'draft-04' ): array<string,

Prepares a JSON Schema for clients.

Description

Use this before exposing a schema outside of WordPress’s server-side validation, for example in REST responses, Ability metadata, or AI provider requests. The prepared schema uses forms that JSON Schema draft-04 clients can understand.

WordPress-internal schema conveniences are converted or removed only where needed to keep the exposed schema valid for the selected profile.

Parameters

mixed> $schema The schema array.
$schema_profilestringoptional: Name of the schema profile whose keywords should be preserved.
Default 'draft-04'.
Default:'draft-04'

Return

array<string, mixed> The prepared schema.

Source

function wp_prepare_json_schema_for_client( array $schema, string $schema_profile = 'draft-04' ): array {
	$allowed_keywords = array_fill_keys( wp_get_json_schema_allowed_keywords( $schema_profile ), true );

	return _wp_prepare_json_schema_for_client_with_allowed_keywords( $schema, $allowed_keywords );
}

View all references View on Trac View on GitHub

Uses	Description
wp_get_json_schema_allowed_keywords()`wp-includes/json-schema.php`	Gets the JSON Schema keywords allowed for a given schema profile.
_wp_prepare_json_schema_for_client_with_allowed_keywords()`wp-includes/json-schema.php`	Prepares a JSON Schema for clients using a given keyword lookup.

Used by	Description
WP_AI_Client_Prompt_Builder::using_abilities()`wp-includes/ai-client/class-wp-ai-client-prompt-builder.php`	Registers WordPress abilities as function declarations for the AI model.
WP_REST_Abilities_V1_List_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-list-controller.php`	Prepares an ability for response.

Changelog

Version	Description
7.1.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.