wppaste
WordPress

WP_REST_Font_Families_Controller::get_item_schema(): array

Since
6.5.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-font-families-controller.php:289
Retrieves the post's schema, conforming to JSON Schema.

Compatibility

WordPress
since 6.5.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_Font_Families_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–85

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
3

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

WhenInstructionsCalls it makes
always8->add_additional_fields_schema()
always85__(), __(), __(), __(), __(), __(), __(), __(), ->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: 91 instructions, 8–85 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_Font_Families_Controller::add_additional_fields_schema()

Used by · 3

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'      => $this->post_type,			'type'       => 'object',			// Base properties for every Post.			'properties' => array(				'id'                   => array(					'description' => __( 'Unique identifier for the post.', 'default' ),					'type'        => 'integer',					'context'     => array( 'view', 'edit', 'embed' ),					'readonly'    => true,				),				'theme_json_version'   => array(					'description' => __( 'Version of the theme.json schema used for the typography settings.' ),					'type'        => 'integer',					'default'     => static::LATEST_THEME_JSON_VERSION_SUPPORTED,					'minimum'     => 2,					'maximum'     => static::LATEST_THEME_JSON_VERSION_SUPPORTED,					'context'     => array( 'view', 'edit', 'embed' ),				),				'font_faces'           => array(					'description' => __( 'The IDs of the child font faces in the font family.' ),					'type'        => 'array',					'context'     => array( 'view', 'edit', 'embed' ),					'items'       => array(						'type' => 'integer',					),				),				// Font family settings come directly from theme.json schema				// See https://schemas.wp.org/trunk/theme.json				'font_family_settings' => array(					'description'          => __( 'font-face definition in theme.json format.' ),					'type'                 => 'object',					'context'              => array( 'view', 'edit', 'embed' ),					'properties'           => array(						'name'       => array(							'description' => __( 'Name of the font family preset, translatable.' ),							'type'        => 'string',							'arg_options' => array(								'sanitize_callback' => 'sanitize_text_field',							),						),						'slug'       => array(							'description' => __( 'Kebab-case unique identifier for the font family preset.' ),							'type'        => 'string',							'arg_options' => array(								'sanitize_callback' => 'sanitize_title',							),						),						'fontFamily' => array(							'description' => __( 'CSS font-family value.' ),							'type'        => 'string',							'arg_options' => array(								'sanitize_callback' => array( 'WP_Font_Utils', 'sanitize_font_family' ),							),						),						'preview'    => array(							'description' => __( 'URL to a preview image of the font family.' ),							'type'        => 'string',							'format'      => 'uri',							'default'     => '',							'arg_options' => array(								'sanitize_callback' => 'sanitize_url',							),						),					),					'required'             => array( 'name', 'slug', 'fontFamily' ),					'additionalProperties' => false,				),			),		); 		$this->schema = $schema; 		return $this->add_additional_fields_schema( $this->schema );

Changelog

Introduced in 6.5.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-font-families-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.