wppaste
WordPress

WP_REST_Site_Health_Controller::get_item_schema(): array

Since
5.6.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-site-health-controller.php:350
Gets the schema for each site health test.

Compatibility

WordPress
since 5.6.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
The test schema.

Performance profile

How much work a call to WP_REST_Site_Health_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
4–54

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

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

WhenInstructionsCalls it makes
always4none
always54__(), __(), __(), __(), __(), __()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 56 instructions, 4–54 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 · 1

  • __()Retrieves the translation of $text.

Source code

	public function get_item_schema() {		if ( $this->schema ) {			return $this->schema;		} 		$this->schema = array(			'$schema'    => 'http://json-schema.org/draft-04/schema#',			'title'      => 'wp-site-health-test',			'type'       => 'object',			'properties' => array(				'test'        => array(					'type'        => 'string',					'description' => __( 'The name of the test being run.' ),					'readonly'    => true,				),				'label'       => array(					'type'        => 'string',					'description' => __( 'A label describing the test.' ),					'readonly'    => true,				),				'status'      => array(					'type'        => 'string',					'description' => __( 'The status of the test.' ),					'enum'        => array( 'good', 'recommended', 'critical' ),					'readonly'    => true,				),				'badge'       => array(					'type'        => 'object',					'description' => __( 'The category this test is grouped in.' ),					'properties'  => array(						'label' => array(							'type'     => 'string',							'readonly' => true,						),						'color' => array(							'type'     => 'string',							'enum'     => array( 'blue', 'orange', 'red', 'green', 'purple', 'gray' ),							'readonly' => true,						),					),					'readonly'    => true,				),				'description' => array(					'type'        => 'string',					'description' => __( 'A more descriptive explanation of what the test looks for, and why it is important for the user.' ),					'readonly'    => true,				),				'actions'     => array(					'type'        => 'string',					'description' => __( 'HTML containing an action to direct the user to where they can resolve the issue.' ),					'readonly'    => true,				),			),		); 		return $this->schema;	}

Changelog

Introduced in 5.6.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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-site-health-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.