WP_REST_Block_Patterns_Controller::get_item_schema() – Retrieves the block pattern schema, conforming to JSON Schema.

You appear to be a bot. Output may be restricted

Description

Retrieves the block pattern schema, conforming to JSON Schema.

Usage

$array = WP_REST_Block_Patterns_Controller::get_item_schema();

Parameters

Returns

array Item schema data.

Source

File name: wordpress/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php


Lines:

1 to 66 of 66
  public function get_item_schema() {
    $schema = array(
      '$schema'    => 'http://json-schema.org/draft-04/schema#',
      'title'      => 'block-pattern',
      'type'       => 'object',
      'properties' => array(
        'name'           => array(
          'description' => __( 'The pattern name.' ),
          'type'        => 'string',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'title'          => array(
          'description' => __( 'The pattern title, in human readable format.' ),
          'type'        => 'string',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'description'    => array(
          'description' => __( 'The pattern detailed description.' ),
          'type'        => 'string',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'viewport_width' => array(
          'description' => __( 'The pattern viewport width for inserter preview.' ),
          'type'        => 'number',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'block_types'    => array(
          'description' => __( 'Block types that the pattern is intended to be used with.' ),
          'type'        => 'array',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'categories'     => array(
          'description' => __( 'The pattern category slugs.' ),
          'type'        => 'array',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'keywords'       => array(
          'description' => __( 'The pattern keywords.' ),
          'type'        => 'array',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'content'        => array(
          'description' => __( 'The pattern content.' ),
          'type'        => 'string',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
        'inserter'       => array(
          'description' => __( 'Determines whether the pattern is visible in inserter.' ),
          'type'        => 'boolean',
          'readonly'    => true,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
      ),
    );

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

 View on GitHub View on Trac