WP_REST_Blocks_Controller::get_item_schema │ public │ WP 5.0.0

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

Method of the class: WP_REST_Blocks_Controller{}

No Hooks.

Returns

Array. Item schema data.

Usage

$WP_REST_Blocks_Controller = new WP_REST_Blocks_Controller();
$WP_REST_Blocks_Controller->get_item_schema();

Changelog

WP_REST_Blocks_Controller::get_item_schema() WP REST Blocks Controller::get item schema code ^{WP 6.8.3}

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