W3cubDocs

/WordPress

WP_REST_Server::add_site_icon_to_index( WP_REST_Response $response )

Exposes the site icon 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.

Source

protected function add_site_icon_to_index( WP_REST_Response $response ) {
	$site_icon_id = get_option( 'site_icon', 0 );

	$this->add_image_to_index( $response, $site_icon_id, 'site_icon' );

	$response->data['site_icon_url'] = get_site_icon_url();
}

Changelog

Version Description
5.9.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_server/add_site_icon_to_index