wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_prepare_json_schema_for_client › WordPress Function

Since7.1.0
Deprecatedn/a
› wp_prepare_json_schema_for_client ( $schema, $schema_profile = 'draft-04' )
Parameters: (2)
  • (array<string,mixed>) $schema The schema array.
    Required: Yes
  • (string) $schema_profile Optional. Name of the schema profile whose keywords should be preserved. Default &#039;draft-04&#039;.
    Required: No
    Default: 'draft-04'
Returns:
  • (array<string,mixed>) The prepared schema.
Defined at:
Codex:

Prepares a JSON Schema for clients.

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.


Related Functions: _wp_prepare_json_schema_for_client_with_allowed_keywords, wp_prepare_revisions_for_js, wp_prepare_themes_for_js, wp_prepare_attachment_for_js, wp_popular_terms_checklist

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 );
}