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

You appear to be a bot. Output may be restricted

Description

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

Usage

$array = WP_REST_Pattern_Directory_Controller::get_item_schema();

Parameters

Returns

array Item schema data.

Source

File name: wordpress/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php


Lines:

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

    $this->schema = array(
      '$schema'    => 'http://json-schema.org/draft-04/schema#',
      'title'      => 'pattern-directory-item',
      'type'       => 'object',
      'properties' => array(
        'id'             => array(
          'description' => __( 'The pattern ID.' ),
          'type'        => 'integer',
          'minimum'     => 1,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),

        'title'          => array(
          'description' => __( 'The pattern title, in human readable format.' ),
          'type'        => 'string',
          'minLength'   => 1,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),

        'content'        => array(
          'description' => __( 'The pattern content.' ),
          'type'        => 'string',
          'minLength'   => 1,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),

        'categories'     => array(
          'description' => __( "The pattern's category slugs." ),
          'type'        => 'array',
          'uniqueItems' => true,
          'items'       => array( 'type' => 'string' ),
          'context'     => array( 'view', 'edit', 'embed' ),
        ),

        'keywords'       => array(
          'description' => __( "The pattern's keywords." ),
          'type'        => 'array',
          'uniqueItems' => true,
          'items'       => array( 'type' => 'string' ),
          'context'     => array( 'view', 'edit', 'embed' ),
        ),

        'description'    => array(
          'description' => __( 'A description of the pattern.' ),
          'type'        => 'string',
          'minLength'   => 1,
          'context'     => array( 'view', 'edit', 'embed' ),
        ),

        'viewport_width' => array(
          'description' => __( 'The preferred width of the viewport when previewing a pattern, in pixels.' ),
          'type'        => 'integer',
          'context'     => array( 'view', 'edit', 'embed' ),
        ),
      ),
    );

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

 View on GitHub View on Trac