WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Server::add_image_to_index()

WP_REST_Server::add_image_to_index( WP_REST_Response $response, int $image_id, string $type )

In this article

Back to top

Exposes an image through the WordPress REST API.

Description

This is used for fetching this information when user has no rights to update settings.

Parameters

$responseWP_REST_Responserequired
REST API response.
$image_idintrequired
Image attachment ID.
$typestringrequired
Type of Image.

Source

protected function add_image_to_index( WP_REST_Response $response, $image_id, $type ) {
	$response->data[ $type ] = (int) $image_id;
	if ( $image_id ) {
		$response->add_link(
			'https://api.w.org/featuredmedia',
			rest_url( rest_get_route_for_post( $image_id ) ),
			array(
				'embeddable' => true,
				'type'       => $type,
			)
		);
	}
}

View all references View on Trac View on GitHub

UsesDescription
rest_get_route_for_post()wp-includes/rest-api.php

Gets the REST API route for a post.

rest_url()wp-includes/rest-api.php

Retrieves the URL to a REST endpoint.

Used byDescription
WP_REST_Server::add_site_icon_to_index()wp-includes/rest-api/class-wp-rest-server.php

Exposes the site icon through the WordPress REST API.

WP_REST_Server::add_site_logo_to_index()wp-includes/rest-api/class-wp-rest-server.php

Exposes the site logo through the WordPress REST API.

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.