Changeset 52080 for trunk/src/wp-includes/rest-api/class-wp-rest-server.php

Timestamp:

11/09/2021 08:36:37 PM (3 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Expose the site icon in the REST API index.

Props spacedmonkey, palmiak.
Fixes #52321.

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-server.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -1230 +1230 @@
         $this->add_active_theme_link_to_index( $response );
         $this->add_site_logo_to_index( $response );
+        $this->add_site_icon_to_index( $response );
 
         /**
@@ -1276 +1277 @@
     /**
      * Exposes the site logo through the WordPress REST API.
+     *
      * This is used for fetching this information when user has no rights
      * to update settings.
@@ -1284 +1286 @@
      */
     protected function add_site_logo_to_index( WP_REST_Response $response ) {
-        $site_logo_id                = get_theme_mod( 'custom_logo' );
-        $response->data['site_logo'] = $site_logo_id;
-        if ( $site_logo_id ) {
+        $site_logo_id = get_theme_mod( 'custom_logo', 0 );
+
+        $this->add_image_to_index( $response, $site_logo_id, 'site_logo' );
+    }
+
+    /**
+     * Exposes the site icon through the WordPress REST API.
+     *
+     * This is used for fetching this information when user has no rights
+     * to update settings.
+     *
+     * @since 5.9.0
+     *
+     * @param WP_REST_Response $response REST API response.
+     */
+    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' );
+    }
+
+    /**
+     * Exposes an image through the WordPress REST API.
+     * This is used for fetching this information when user has no rights
+     * to update settings.
+     *
+     * @since 5.9.0
+     *
+     * @param WP_REST_Response $response REST API response.
+     * @param int              $image_id Image attachment ID.
+     * @param string           $type     Type of Image.
+     */
+    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( $site_logo_id ) ),
+                rest_url( rest_get_route_for_post( $image_id ) ),
                 array(
                     'embeddable' => true,
+                    'type'       => $type,
                 )
             );