WP_REST_URL_Details_Controller::get_item_schema() │ public │ WP 5.9.0

Retrieves the item's schema, conforming to JSON Schema.

Method of the class: WP_REST_URL_Details_Controller{}

No Hooks.

Return

Array. Item schema data.

Usage

$WP_REST_URL_Details_Controller = new WP_REST_URL_Details_Controller();
$WP_REST_URL_Details_Controller->get_item_schema();

Changelog

WP_REST_URL_Details_Controller::get_item_schema() WP REST URL Details Controller::get item schema code ^{WP 6.6.2}

public function get_item_schema() {
	if ( $this->schema ) {
		return $this->add_additional_fields_schema( $this->schema );
	}

	$this->schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'url-details',
		'type'       => 'object',
		'properties' => array(
			'title'       => array(
				'description' => sprintf(
					/* translators: %s: HTML title tag. */
					__( 'The contents of the %s element from the URL.' ),
					'<title>'
				),
				'type'        => 'string',
				'context'     => array( 'view', 'edit', 'embed' ),
				'readonly'    => true,
			),
			'icon'        => array(
				'description' => sprintf(
					/* translators: %s: HTML link tag. */
					__( 'The favicon image link of the %s element from the URL.' ),
					'<link rel="icon">'
				),
				'type'        => 'string',
				'format'      => 'uri',
				'context'     => array( 'view', 'edit', 'embed' ),
				'readonly'    => true,
			),
			'description' => array(
				'description' => sprintf(
					/* translators: %s: HTML meta tag. */
					__( 'The content of the %s element from the URL.' ),
					'<meta name="description">'
				),
				'type'        => 'string',
				'context'     => array( 'view', 'edit', 'embed' ),
				'readonly'    => true,
			),
			'image'       => array(
				'description' => sprintf(
					/* translators: 1: HTML meta tag, 2: HTML meta tag. */
					__( 'The Open Graph image link of the %1$s or %2$s element from the URL.' ),
					'<meta property="og:image">',
					'<meta property="og:image:url">'
				),
				'type'        => 'string',
				'format'      => 'uri',
				'context'     => array( 'view', 'edit', 'embed' ),
				'readonly'    => true,
			),
		),
	);

	return $this->add_additional_fields_schema( $this->schema );
}