wp_prepare_json_schema_for_client( array $schema, string $schema_profile = 'draft-04' ): array<string,
- Since
- 7.1.0
- Source
wp-includes/json-schema.php:90
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.
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$schemaarray$schema_profilestringoptional- Name of the schema profile whose keywords should be preserved.
Default 'draft-04'.Default:'draft-04'
Return value
array<string,- mixed> The prepared schema.
Performance profile
How much work a call to wp_prepare_json_schema_for_client() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 16
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 16.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below wp_prepare_json_schema_for_client()
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_prepare_json_schema_for_client() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 16 | wp_get_json_schema_allowed_keywords(), array_fill_keys(), _wp_prepare_json_schema_for_client_with_allowed_keywords() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 16 instructions, 16 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- wp_get_json_schema_allowed_keywords()Gets the JSON Schema keywords allowed for a given schema profile.
- _wp_prepare_json_schema_for_client_with_allowed_keywords()Prepares a JSON Schema for clients using a given keyword lookup.
Used by · 2
- WP_AI_Client_Prompt_Builder::using_abilities()Registers WordPress abilities as function declarations for the AI model.
- WP_REST_Abilities_V1_List_Controller::prepare_item_for_response()Prepares an ability for response.
Source code
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 );}Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/json-schema.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.