Title: WP_REST_Server::add_image_to_index
Published: February 3, 2022
Last modified: May 20, 2026

---

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

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#description)
 * [Parameters](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#parameters)
 * [Source](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#wp--skip-link--target)

Exposes an image through the WordPress REST API.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#description)󠁿

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

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#parameters)󠁿

 `$response`[WP_REST_Response](https://developer.wordpress.org/reference/classes/wp_rest_response/)
required

REST API response.

`$image_id`intrequired

Image attachment ID.

`$type`stringrequired

Type of Image.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#source)󠁿

    ```php
    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](https://developer.wordpress.org/reference/files/wp-includes/rest-api/class-wp-rest-server.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.0/src/wp-includes/rest-api/class-wp-rest-server.php#L1487)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/rest-api/class-wp-rest-server.php#L1487-L1499)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#related)󠁿

| Uses | Description | 
| [rest_get_route_for_post()](https://developer.wordpress.org/reference/functions/rest_get_route_for_post/)`wp-includes/rest-api.php` |

Gets the REST API route for a post.

  | 
| [rest_url()](https://developer.wordpress.org/reference/functions/rest_url/)`wp-includes/rest-api.php` |

Retrieves the URL to a REST endpoint.

  |

| Used by | Description | 
| [WP_REST_Server::add_site_icon_to_index()](https://developer.wordpress.org/reference/classes/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()](https://developer.wordpress.org/reference/classes/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](https://developer.wordpress.org/reference/classes/wp_rest_server/add_image_to_index/?output_format=md#changelog)󠁿

| Version | Description | 
| [5.9.0](https://developer.wordpress.org/reference/since/5.9.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_rest_server%2Fadd_image_to_index%2F)
before being able to contribute a note or feedback.