W3cubDocs

/WordPress

WP_REST_Blocks_Controller::get_item_schema(): array

Retrieves the pattern’s schema, conforming to JSON Schema.

Return

array Item schema data.

Source

public function get_item_schema() {
	if ( $this->schema ) {
		return $this->add_additional_fields_schema( $this->schema );
	}

	$schema = parent::get_item_schema();

	/*
	 * Allow all contexts to access `title.raw` and `content.raw`.
	 * Clients always need the raw markup of a pattern to do anything useful,
	 * e.g. parse it or display it in an editor.
	 */
	$schema['properties']['title']['properties']['raw']['context']   = array( 'view', 'edit' );
	$schema['properties']['content']['properties']['raw']['context'] = array( 'view', 'edit' );

	/*
	 * Remove `title.rendered` and `content.rendered` from the schema.
	 * It doesn't make sense for a pattern to have rendered content on its own,
	 * since rendering a block requires it to be inside a post or a page.
	 */
	unset( $schema['properties']['title']['properties']['rendered'] );
	unset( $schema['properties']['content']['properties']['rendered'] );

	$this->schema = $schema;

	return $this->add_additional_fields_schema( $this->schema );
}

Changelog

Version Description
5.0.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_blocks_controller/get_item_schema