wppaste
WordPress

WP_REST_Taxonomies_Controller::get_item_schema(): array

Since
4.7.0, 5.0.0, 5.9.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php:332
Retrieves the taxonomy's schema, conforming to JSON Schema.

Compatibility

WordPress
since 5.9.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_Taxonomies_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–141

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

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

WhenInstructionsCalls it makes
always8->add_additional_fields_schema()
always141__(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), __(), ->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: 147 instructions, 8–141 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_Taxonomies_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'      => 'taxonomy',			'type'       => 'object',			'properties' => array(				'capabilities'   => array(					'description' => __( 'All capabilities used by the taxonomy.' ),					'type'        => 'object',					'context'     => array( 'edit' ),					'readonly'    => true,				),				'description'    => array(					'description' => __( 'A human-readable description of the taxonomy.' ),					'type'        => 'string',					'context'     => array( 'view', 'edit' ),					'readonly'    => true,				),				'hierarchical'   => array(					'description' => __( 'Whether or not the taxonomy should have children.' ),					'type'        => 'boolean',					'context'     => array( 'view', 'edit' ),					'readonly'    => true,				),				'labels'         => array(					'description' => __( 'Human-readable labels for the taxonomy for various contexts.' ),					'type'        => 'object',					'context'     => array( 'edit' ),					'readonly'    => true,				),				'name'           => array(					'description' => __( 'The title for the taxonomy.' ),					'type'        => 'string',					'context'     => array( 'view', 'edit', 'embed' ),					'readonly'    => true,				),				'slug'           => array(					'description' => __( 'An alphanumeric identifier for the taxonomy.' ),					'type'        => 'string',					'context'     => array( 'view', 'edit', 'embed' ),					'readonly'    => true,				),				'show_cloud'     => array(					'description' => __( 'Whether or not the term cloud should be displayed.' ),					'type'        => 'boolean',					'context'     => array( 'edit' ),					'readonly'    => true,				),				'types'          => array(					'description' => __( 'Types associated with the taxonomy.' ),					'type'        => 'array',					'items'       => array(						'type' => 'string',					),					'context'     => array( 'view', 'edit' ),					'readonly'    => true,				),				'rest_base'      => array(					'description' => __( 'REST base route for the taxonomy.' ),					'type'        => 'string',					'context'     => array( 'view', 'edit', 'embed' ),					'readonly'    => true,				),				'rest_namespace' => array(					'description' => __( 'REST namespace route for the taxonomy.' ),					'type'        => 'string',					'context'     => array( 'view', 'edit', 'embed' ),					'readonly'    => true,				),				'visibility'     => array(					'description' => __( 'The visibility settings for the taxonomy.' ),					'type'        => 'object',					'context'     => array( 'edit' ),					'readonly'    => true,					'properties'  => array(						'public'             => array(

Changelog

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

5.9.0
The rest_namespace property was added.from the docblock
5.0.0
The visibility property was added.from the docblock
4.7.0
Introduced.from the docblock

About this page

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