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

Description

Parameters

$responseWP_REST_Response

REST API response.

$image_idint

Image attachment ID.

$typestring

Type of Image.

Uses · 2

• rest_url()Retrieves the URL to a REST endpoint.
• rest_get_route_for_post()Gets the REST API route for a post.

Used by · 2

• WP_REST_Server::add_site_icon_to_index()Exposes the site icon through the WordPress REST API.
• WP_REST_Server::add_site_logo_to_index()Exposes the site logo through the WordPress REST API.

Source

View on Trac ↗View on GitHub ↗

1493	protected function add_image_to_index( WP_REST_Response $response, $image_id, $type ) {1494		$response->data[ $type ] = (int) $image_id;1495		if ( $image_id ) {1496			$response->add_link(1497				'https://api.w.org/featuredmedia',1498				rest_url( rest_get_route_for_post( $image_id ) ),1499				array(1500					'embeddable' => true,1501					'type'       => $type,1502				)1503			);1504		}1505	}

History

Introduced in 5.9.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.0.4 tag, from src/wp-includes/rest-api/class-wp-rest-server.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.