WP_REST_Block_Types_Controller::get_item_schema() public WP 5.5.0

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

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

No Hooks.

Return

Array. Item schema data.

Usage

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

Changelog

Code of WP_REST_Block_Types_Controller::get_item_schema() WP REST Block Types Controller::get item schema ^{WP 5.6}

<?php
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'      => 'block-type',
		'type'       => 'object',
		'properties' => array(
			'api_version'      => array(
				'description' => __( 'Version of block API.' ),
				'type'        => 'integer',
				'default'     => 1,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'title'            => array(
				'description' => __( 'Title of block type.' ),
				'type'        => 'string',
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'name'             => array(
				'description' => __( 'Unique name identifying the block type.' ),
				'type'        => 'string',
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'description'      => array(
				'description' => __( 'Description of block type.' ),
				'type'        => 'string',
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'icon'             => array(
				'description' => __( 'Icon of block type.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'attributes'       => array(
				'description'          => __( 'Block attributes.' ),
				'type'                 => array( 'object', 'null' ),
				'properties'           => array(),
				'default'              => null,
				'additionalProperties' => array(
					'type' => 'object',
				),
				'context'              => array( 'embed', 'view', 'edit' ),
				'readonly'             => true,
			),
			'provides_context' => array(
				'description'          => __( 'Context provided by blocks of this type.' ),
				'type'                 => 'object',
				'properties'           => array(),
				'additionalProperties' => array(
					'type' => 'string',
				),
				'default'              => array(),
				'context'              => array( 'embed', 'view', 'edit' ),
				'readonly'             => true,
			),
			'uses_context'     => array(
				'description' => __( 'Context values inherited by blocks of this type.' ),
				'type'        => 'array',
				'default'     => array(),
				'items'       => array(
					'type' => 'string',
				),
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'supports'         => array(
				'description' => __( 'Block supports.' ),
				'type'        => 'object',
				'default'     => array(),
				'properties'  => array(),
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'category'         => array(
				'description' => __( 'Block category.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'is_dynamic'       => array(
				'description' => __( 'Is the block dynamically rendered.' ),
				'type'        => 'boolean',
				'default'     => false,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'editor_script'    => array(
				'description' => __( 'Editor script handle.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'script'           => array(
				'description' => __( 'Public facing script handle.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'editor_style'     => array(
				'description' => __( 'Editor style handle.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'style'            => array(
				'description' => __( 'Public facing style handle.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'styles'           => array(
				'description' => __( 'Block style variations.' ),
				'type'        => 'array',
				'items'       => array(
					'type'       => 'object',
					'properties' => array(
						'name'         => array(
							'description' => __( 'Unique name identifying the style.' ),
							'type'        => 'string',
							'required'    => true,
						),
						'label'        => array(
							'description' => __( 'The human-readable label for the style.' ),
							'type'        => 'string',
						),
						'inline_style' => array(
							'description' => __( 'Inline CSS code that registers the CSS class required for the style.' ),
							'type'        => 'string',
						),
						'style_handle' => array(
							'description' => __( 'Contains the handle that defines the block style.' ),
							'type'        => 'string',
						),
					),
				),
				'default'     => array(),
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'textdomain'       => array(
				'description' => __( 'Public text domain.' ),
				'type'        => array( 'string', 'null' ),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'parent'           => array(
				'description' => __( 'Parent blocks.' ),
				'type'        => array( 'array', 'null' ),
				'items'       => array(
					'type' => 'string',
				),
				'default'     => null,
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'keywords'         => array(
				'description' => __( 'Block keywords.' ),
				'type'        => 'array',
				'items'       => array(
					'type' => 'string',
				),
				'default'     => array(),
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'example'          => array(
				'description' => __( 'Block example.' ),
				'type'        => array( 'object', 'null' ),
				'default'     => null,
				'properties'  => array(
					'attributes'  => array(
						'description' => __( 'The attributes used in the example.' ),
						'type'        => 'object',
					),
					'innerBlocks' => array(
						'description' => __( 'The list of inner blocks used in the example.' ),
						'type'        => 'array',
						'items'       => array(
							'type'       => 'object',
							'properties' => array(
								'name'        => array(
									'description' => __( 'The name of the inner block.' ),
									'type'        => 'string',
								),
								'attributes'  => array(
									'description' => __( 'The attributes of the inner block.' ),
									'type'        => 'object',
								),
								'innerBlocks' => array(
									'description' => __( "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema." ),
									'type'        => 'array',
								),
							),
						),
					),
				),
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
		),
	);

	$this->schema = $schema;

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