WP_REST_Templates_Controller::get_item_schema()publicWP 5.8.0

Retrieves the block type' schema, conforming to JSON Schema.

{} It's a method of the class: WP_REST_Templates_Controller{}

No Hooks.

Return

Array. Item schema data.

Usage

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

Changelog

Since 5.8.0 Introduced.
Since 5.9.0 Added 'area'.

Code of WP_REST_Templates_Controller::get_item_schema() WP 6.0

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

	$schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => $this->post_type,
		'type'       => 'object',
		'properties' => array(
			'id'             => array(
				'description' => __( 'ID of template.' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'slug'           => array(
				'description' => __( 'Unique slug identifying the template.' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
				'required'    => true,
				'minLength'   => 1,
				'pattern'     => '[a-zA-Z0-9_\-]+',
			),
			'theme'          => array(
				'description' => __( 'Theme identifier for the template.' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
			),
			'type'           => array(
				'description' => __( 'Type of template.' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
			),
			'source'         => array(
				'description' => __( 'Source of template' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'origin'         => array(
				'description' => __( 'Source of a customized template' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'content'        => array(
				'description' => __( 'Content of template.' ),
				'type'        => array( 'object', 'string' ),
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
				'properties'  => array(
					'raw'           => array(
						'description' => __( 'Content for the template, as it exists in the database.' ),
						'type'        => 'string',
						'context'     => array( 'view', 'edit' ),
					),
					'block_version' => array(
						'description' => __( 'Version of the content block format used by the template.' ),
						'type'        => 'integer',
						'context'     => array( 'edit' ),
						'readonly'    => true,
					),
				),
			),
			'title'          => array(
				'description' => __( 'Title of template.' ),
				'type'        => array( 'object', 'string' ),
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
				'properties'  => array(
					'raw'      => array(
						'description' => __( 'Title for the template, as it exists in the database.' ),
						'type'        => 'string',
						'context'     => array( 'view', 'edit', 'embed' ),
					),
					'rendered' => array(
						'description' => __( 'HTML title for the template, transformed for display.' ),
						'type'        => 'string',
						'context'     => array( 'view', 'edit', 'embed' ),
						'readonly'    => true,
					),
				),
			),
			'description'    => array(
				'description' => __( 'Description of template.' ),
				'type'        => 'string',
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
			),
			'status'         => array(
				'description' => __( 'Status of template.' ),
				'type'        => 'string',
				'enum'        => array_keys( get_post_stati( array( 'internal' => false ) ) ),
				'default'     => 'publish',
				'context'     => array( 'embed', 'view', 'edit' ),
			),
			'wp_id'          => array(
				'description' => __( 'Post ID.' ),
				'type'        => 'integer',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'has_theme_file' => array(
				'description' => __( 'Theme file exists.' ),
				'type'        => 'bool',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'author'         => array(
				'description' => __( 'The ID for the author of the template.' ),
				'type'        => 'integer',
				'context'     => array( 'view', 'edit', 'embed' ),
			),
		),
	);

	if ( 'wp_template' === $this->post_type ) {
		$schema['properties']['is_custom'] = array(
			'description' => __( 'Whether a template is a custom template.' ),
			'type'        => 'bool',
			'context'     => array( 'embed', 'view', 'edit' ),
			'readonly'    => true,
		);
	}

	if ( 'wp_template_part' === $this->post_type ) {
		$schema['properties']['area'] = array(
			'description' => __( 'Where the template part is intended for use (header, footer, etc.)' ),
			'type'        => 'string',
			'context'     => array( 'embed', 'view', 'edit' ),
		);
	}

	$this->schema = $schema;

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