<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[52080] trunk: REST API: Expose the site icon in the REST API index.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/52080">52080</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/52080","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-09 20:36:37 +0000 (Tue, 09 Nov 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Expose the site icon in the REST API index.
Props spacedmonkey, palmiak.
Fixes <a href="https://core.trac.wordpress.org/ticket/52321">#52321</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiclasswprestserverphp">trunk/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestserverphp">trunk/tests/phpunit/tests/rest-api/rest-server.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiclasswprestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/class-wp-rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2021-11-09 18:58:59 UTC (rev 52079)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2021-11-09 20:36:37 UTC (rev 52080)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1229,6 +1229,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response->add_link( 'help', 'https://developer.wordpress.org/rest-api/' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_active_theme_link_to_index( $response );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_site_logo_to_index( $response );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->add_site_icon_to_index( $response );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the REST API root index data.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1275,6 +1276,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Exposes the site logo through the WordPress REST API.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * This is used for fetching this information when user has no rights
</span><span class="cx" style="display: block; padding: 0 10px"> * to update settings.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1283,14 +1285,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Response $response REST API response.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function add_site_logo_to_index( WP_REST_Response $response ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $site_logo_id = get_theme_mod( 'custom_logo' );
- $response->data['site_logo'] = $site_logo_id;
- if ( $site_logo_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $response->add_link(
</span><span class="cx" style="display: block; padding: 0 10px"> 'https://api.w.org/featuredmedia',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- rest_url( rest_get_route_for_post( $site_logo_id ) ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ rest_url( rest_get_route_for_post( $image_id ) ),
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'embeddable' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => $type,
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-server.php 2021-11-09 18:58:59 UTC (rev 52079)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2021-11-09 20:36:37 UTC (rev 52080)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,6 +10,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group restapi
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_REST_Server extends WP_Test_REST_TestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $icon_id;
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ $filename = DIR_TESTDATA . '/images/test-image-large.jpg';
+ self::$icon_id = $factory->attachment->create_upload_object( $filename );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function set_up() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::set_up();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1007,8 +1014,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'help', $index->get_links() );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'wp:active-theme', $index->get_links() );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Check site icon.
+ $this->assertArrayHasKey( 'site_icon', $data );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 52321
+ */
+ public function test_get_index_with_site_icon() {
+ $server = new WP_REST_Server();
+ update_option( 'site_icon', self::$icon_id );
+
+ $request = new WP_REST_Request( 'GET', '/' );
+ $index = $server->dispatch( $request );
+ $data = $index->get_data();
+
+ $this->assertArrayHasKey( 'site_icon', $data );
+ $this->assertEquals( self::$icon_id, $data['site_icon'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_namespace_index() {
</span><span class="cx" style="display: block; padding: 0 10px"> $server = new WP_REST_Server();
</span><span class="cx" style="display: block; padding: 0 10px"> $server->register_route(
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2021-11-09 18:58:59 UTC (rev 52079)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2021-11-09 20:36:37 UTC (rev 52080)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10369,7 +10369,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ]
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "site_logo": false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "site_logo": 0,
+ "site_icon": 0
</ins><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> mockedApiResponse.oembed = {
</span></span></pre>
</div>
</div>
</body>
</html>