wppaste
WordPress

WP_REST_Block_Patterns_Controller::get_item_schema(): array

Since
6.0.0, 6.3.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php:207
Retrieves the block pattern schema, conforming to JSON Schema.

Compatibility

WordPress
since 6.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

array
Item schema data.

Performance profile

How much work a call to WP_REST_Block_Patterns_Controller::get_item_schema() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
8–112

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 118.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Block_Patterns_Controller::get_item_schema() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always8->add_additional_fields_schema()
always112__(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), ->add_additional_fields_schema()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 118 instructions, 8–112 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

  • __()Retrieves the translation of $text.
  • WP_REST_Block_Patterns_Controller::add_additional_fields_schema()

Source code

View on Trac View on GitHub 

	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-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' ),				),				'content'        => array(					'description' => __( 'The pattern content.' ),					'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' ),				),				'inserter'       => array(					'description' => __( 'Determines whether the pattern is visible in inserter.' ),					'type'        => 'boolean',					'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' ),				),				'block_types'    => array(					'description' => __( 'Block types that the pattern is intended to be used with.' ),					'type'        => 'array',					'readonly'    => true,					'context'     => array( 'view', 'edit', 'embed' ),				),				'post_types'     => array(					'description' => __( 'An array of post types that the pattern is restricted to be used with.' ),					'type'        => 'array',					'readonly'    => true,					'context'     => array( 'view', 'edit', 'embed' ),				),				'template_types' => array(					'description' => __( 'An array of template types where the pattern fits.' ),					'type'        => 'array',					'readonly'    => true,					'context'     => array( 'view', 'edit', 'embed' ),				),				'source'         => array(					'description' => __( 'Where the pattern comes from e.g. core' ),					'type'        => 'string',					'readonly'    => true,

Changelog

Introduced in 6.0.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.3.0
Added source property.from the docblock
6.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.