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



wp_get_json_schema_allowed_keywords › WordPress Function

Since7.1.0
Deprecatedn/a
› wp_get_json_schema_allowed_keywords ( $schema_profile = 'rest-api' )
Parameters:
  • (string) $schema_profile Optional. Name of the schema profile to get keywords for. Accepts 'rest-api' or 'draft-04'. Any other value falls back to the 'rest-api' profile. Default 'rest-api'.
    Required: No
    Default: 'rest-api'
Returns:
  • (string[]) Allowed JSON Schema keywords.
Defined at:
Codex:

Gets the JSON Schema keywords allowed for a given schema profile.

Use the returned list to decide which keywords to keep when a schema is output as JSON. Both profiles describe JSON Schema draft-04 output, also called JSON Schema Version 4. They differ only in how much of the keyword vocabulary stays in the result. - 'rest-api' returns the subset of draft-04 that the WordPress REST API uses for route output. This is the default. - 'draft-04' returns the larger draft-04 set used when publishing a schema as a standalone document to clients, such as the Abilities API. It keeps documentation and passthrough keywords like '$ref', 'definitions', 'allOf', 'not', 'dependencies', and 'additionalItems'. The keywords are allowed to stay in the schema output. This does not mean WordPress validates or sanitizes values against them.


Related Functions: rest_get_allowed_schema_keywords, wp_get_nocache_headers, get_site_allowed_themes, _wp_get_allowed_postdata, wpmu_get_blog_allowedthemes

Source 

function wp_get_json_schema_allowed_keywords( string $schema_profile = 'rest-api' ): array {
	$rest_keywords = rest_get_allowed_schema_keywords();

	$keywords_by_profile = array(
		'rest-api' => $rest_keywords,
		'draft-04' => array_merge(
			array(
				'$schema',
				'id',
				'$ref',
			),
			$rest_keywords,
			array(
				'required',
				'allOf',
				'not',
				'definitions',
				'dependencies',
				'additionalItems',
			)
		),
	);

	$allowed_keywords = $keywords_by_profile[ $schema_profile ] ?? $rest_keywords;

	/**
	 * Filters the JSON Schema keywords allowed for a given schema profile.
	 *
	 * Adding a keyword lets it stay in the schema output for that profile.
	 * It does not make WordPress validate or sanitize values against the keyword.
	 *
	 * @since 7.1.0
	 *
	 * @param string[] $allowed_keywords Allowed JSON Schema keywords.
	 * @param string   $schema_profile   The schema profile the keywords are for.
	 */
	return apply_filters( 'wp_json_schema_allowed_keywords', $allowed_keywords, $schema_profile );
}