wppaste
WordPress

WP_REST_Sidebars_Controller::get_item_schema(): array

Since
5.8.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:435
Retrieves the block type' schema, conforming to JSON Schema.

Compatibility

WordPress
since 5.8.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_Sidebars_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–101

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

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_Sidebars_Controller::get_item_schema() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always8->add_additional_fields_schema()
always101__(), __(), __(), __(), __(), __(), __(), __(), __(), __(), ->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: 107 instructions, 8–101 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_Sidebars_Controller::add_additional_fields_schema()

Used by · 1

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'      => 'sidebar',			'type'       => 'object',			'properties' => array(				'id'            => array(					'description' => __( 'ID of sidebar.' ),					'type'        => 'string',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'name'          => array(					'description' => __( 'Unique name identifying the sidebar.' ),					'type'        => 'string',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'description'   => array(					'description' => __( 'Description of sidebar.' ),					'type'        => 'string',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'class'         => array(					'description' => __( 'Extra CSS class to assign to the sidebar in the Widgets interface.' ),					'type'        => 'string',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'before_widget' => array(					'description' => __( 'HTML content to prepend to each widget\'s HTML output when assigned to this sidebar. Default is an opening list item element.' ),					'type'        => 'string',					'default'     => '',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'after_widget'  => array(					'description' => __( 'HTML content to append to each widget\'s HTML output when assigned to this sidebar. Default is a closing list item element.' ),					'type'        => 'string',					'default'     => '',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'before_title'  => array(					'description' => __( 'HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.' ),					'type'        => 'string',					'default'     => '',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'after_title'   => array(					'description' => __( 'HTML content to append to the sidebar title when displayed. Default is a closing h2 element.' ),					'type'        => 'string',					'default'     => '',					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'status'        => array(					'description' => __( 'Status of sidebar.' ),					'type'        => 'string',					'enum'        => array( 'active', 'inactive' ),					'context'     => array( 'embed', 'view', 'edit' ),					'readonly'    => true,				),				'widgets'       => array(					'description' => __( 'Nested widgets.' ),					'type'        => 'array',					'items'       => array(						'type' => array( 'object', 'string' ),					),					'default'     => array(),					'context'     => array( 'embed', 'view', 'edit' ),				),			),		);

Changelog

Introduced in 5.8.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.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-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.