<!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>[57154] branches/6.4/tests/phpunit/tests/rest-api/rest-server.php: REST API: Restore site logo and icon in 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/57154">57154</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/57154","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-12-04 19:42:44 +0000 (Mon, 04 Dec 2023)</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: Restore site logo and icon in index.
Restores setting the site's logo, icon, and wp-admin's back button image (which defaults to W).
Prior to <a href="https://core.trac.wordpress.org/changeset/56566">[56566]</a>, the site logo and icon were unconditionally added to the index. <a href="https://core.trac.wordpress.org/changeset/56566">[56566]</a> changed this by conditionally adding them if either the `_links` or `_embedded` fields were included. However, these fields are not included when using the Site Logo block, as it uses the `site_logo`, `site_icon`, and `site_icon_url` fields instead.
This changeset restores the functionality by checking specifically for the `site_*` fields when neither of the `_links` or `_embedded` fields are present.
Follow up to <a href="https://core.trac.wordpress.org/changeset/56566">[56566]</a>.
Reviewed by jorbin.
Merges <a href="https://core.trac.wordpress.org/changeset/57147">[57147]</a> to the 6.4 branch.
Props antonvlasenko, hellofromTonya, ironprogrammer, priethor, wildworks.
Fixes <a href="https://core.trac.wordpress.org/ticket/59935">#59935</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches64srcwpincludesrestapiclasswprestserverphp">branches/6.4/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>
<li><a href="#branches64testsphpunittestsrestapirestserverphp">branches/6.4/tests/phpunit/tests/rest-api/rest-server.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches64">branches/6.4/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.4
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.4 2023-12-04 19:36:27 UTC (rev 57153)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.4 2023-12-04 19:42:44 UTC (rev 57154)
</ins><a id="branches64"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.4</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:56974,56978,56984,56987,56990-56992,56996,56999,57003,57009,57012-57013,57018-57019,57021-57022,57028-57029,57032-57034,57036,57044,57046,57048,57054,57063,57066-57067,57069,57075,57081,57084,57086,57089,57093,57102
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:56974,56978,56984,56987,56990-56992,56996,56999,57003,57009,57012-57013,57018-57019,57021-57022,57028-57029,57032-57034,57036,57044,57046,57048,57054,57063,57066-57067,57069,57075,57081,57084,57086,57089,57093,57102,57147
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches64srcwpincludesrestapiclasswprestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.4/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">--- branches/6.4/src/wp-includes/rest-api/class-wp-rest-server.php 2023-12-04 19:36:27 UTC (rev 57153)
+++ branches/6.4/src/wp-includes/rest-api/class-wp-rest-server.php 2023-12-04 19:42:44 UTC (rev 57154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1294,6 +1294,13 @@
</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><span class="cx" style="display: block; padding: 0 10px"> $this->add_site_icon_to_index( $response );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ if ( rest_is_field_included( 'site_logo', $fields ) ) {
+ $this->add_site_logo_to_index( $response );
+ }
+ if ( rest_is_field_included( 'site_icon', $fields ) || rest_is_field_included( 'site_icon_url', $fields ) ) {
+ $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"> /**
</span></span></pre></div>
<a id="branches64testsphpunittestsrestapirestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.4/tests/phpunit/tests/rest-api/rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.4/tests/phpunit/tests/rest-api/rest-server.php 2023-12-04 19:36:27 UTC (rev 57153)
+++ branches/6.4/tests/phpunit/tests/rest-api/rest-server.php 2023-12-04 19:42:44 UTC (rev 57154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1187,19 +1187,134 @@
</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"> * @ticket 52321
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 59935
+ *
+ * @covers WP_REST_Server::get_index
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_index_includes_site_icon() {
- $server = new WP_REST_Server();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_index_should_include_site_icon() {
</ins><span class="cx" style="display: block; padding: 0 10px"> update_option( 'site_icon', self::$icon_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $server = new WP_REST_Server();
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/' );
</span><span class="cx" style="display: block; padding: 0 10px"> $index = $server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $index->get_data();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( 'site_icon', $data );
- $this->assertSame( self::$icon_id, $data['site_icon'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'site_logo', $data, 'The "site_logo" field is missing in the response.' );
+ $this->assertArrayHasKey( 'site_icon', $data, 'The "site_icon" field is missing in the response.' );
+ $this->assertArrayHasKey( 'site_icon_url', $data, 'The "site_icon_url" field is missing in the response.' );
+ $this->assertSame( self::$icon_id, $data['site_icon'], 'The response "site_icon" ID does not match.' );
+ $this->assertStringContainsString( 'test-image-large', $data['site_icon_url'], 'The "site_icon_url" should contain the expected image.' );
</ins><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
+ * @ticket 59935
+ *
+ * @covers WP_REST_Server::get_index
+ */
+ public function test_get_index_should_not_include_site_icon() {
+ $server = new WP_REST_Server();
+ $request = new WP_REST_Request( 'GET', '/' );
+ $index = $server->dispatch( $request );
+ $data = $index->get_data();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'site_logo', $data, 'The "site_logo" field is missing in the response.' );
+ $this->assertArrayHasKey( 'site_icon', $data, 'The "site_icon" field is missing in the response.' );
+ $this->assertArrayHasKey( 'site_icon_url', $data, 'The "site_icon_url" field is missing in the response.' );
+ $this->assertSame( 0, $data['site_icon'], 'Response "site_icon" should be 0.' );
+ $this->assertSame( '', $data['site_icon_url'], 'Response "site_icon_url" should be an empty string.' );
+ }
+
+ /**
+ * Test that the "get_index" method returns the expected site_icon*
+ * and site_logo fields based on the specified request parameters.
+ *
+ * @ticket 59935
+ *
+ * @covers WP_REST_Server::get_index
+ *
+ * @dataProvider data_get_index_should_return_site_icon_and_site_logo_fields
+ *
+ * @param string $fields List of fields to use in the request.
+ * @param array $expected_fields Expected fields.
+ * @param array $unexpected_fields Optional. Fields that should not be in the results. Default array().
+ * @param bool $is_embed Optional. Whether to use the "_embed" request parameter. Default false.
+ */
+ public function test_get_index_should_return_site_icon_and_site_logo_fields( $fields, $expected_fields, $unexpected_fields = array(), $is_embed = false ) {
+ $server = new WP_REST_Server();
+ $request = new WP_REST_Request( 'GET', '/', array() );
+ $request->set_param( '_fields', $fields );
+ if ( $is_embed ) {
+ $request->set_param( '_embed', true );
+ }
+
+ $response = $server->get_index( $request )->get_data();
+
+ foreach ( $expected_fields as $expected_field ) {
+ $this->assertArrayHasKey( $expected_field, $response, "Expected \"{$expected_field}\" field is missing in the response." );
+ }
+
+ foreach ( $unexpected_fields as $unexpected_field ) {
+ $this->assertArrayNotHasKey( $unexpected_field, $response, "Response must not contain the \"{$unexpected_field}\" field." );
+ }
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_get_index_should_return_site_icon_and_site_logo_fields() {
+ return array(
+ 'no site_logo or site_icon fields' => array(
+ 'fields' => 'name',
+ 'expected_fields' => array(),
+ 'unexpected_fields' => array( 'site_logo', 'site_icon', 'site_icon_url' ),
+ ),
+ '_links request parameter' => array(
+ 'fields' => '_links',
+ 'expected_fields' => array( 'site_logo', 'site_icon', 'site_icon_url' ),
+ ),
+ '_embed request parameter' => array(
+ 'field' => '_embed',
+ 'expected_fields' => array( 'site_logo', 'site_icon', 'site_icon_url' ),
+ 'unexpected_fields' => array(),
+ 'is_embed' => true,
+ ),
+ 'site_logo field' => array(
+ 'fields' => 'site_logo',
+ 'expected_fields' => array( 'site_logo' ),
+ 'unexpected_fields' => array( 'site_icon', 'site_icon_url' ),
+ ),
+ 'site_icon field' => array(
+ 'fields' => 'site_icon',
+ 'expected_fields' => array( 'site_icon', 'site_icon_url' ),
+ 'unexpected_fields' => array( 'site_logo' ),
+ ),
+ 'site_icon_url field' => array(
+ 'fields' => 'site_icon_url',
+ 'expected_fields' => array( 'site_icon', 'site_icon_url' ),
+ 'unexpected_fields' => array( 'site_logo' ),
+ ),
+ 'site_icon and site_icon_url field' => array(
+ 'fields' => 'site_icon_url',
+ 'expected_fields' => array( 'site_icon', 'site_icon_url' ),
+ 'unexpected_fields' => array( 'site_logo' ),
+ ),
+ 'site_logo and site_icon fields' => array(
+ 'fields' => 'site_logo,site_icon',
+ 'expected_fields' => array( 'site_logo', 'site_icon', 'site_icon_url' ),
+ ),
+ 'site_logo and site_icon_url fields' => array(
+ 'fields' => 'site_logo,site_icon_url',
+ 'expected_fields' => array( 'site_logo', 'site_icon', 'site_icon_url' ),
+ ),
+ 'site_logo, site_icon, and site_icon_url fields' => array(
+ 'fields' => 'site_logo,site_icon,site_icon_url',
+ 'expected_fields' => array( 'site_logo', 'site_icon', 'site_icon_url' ),
+ ),
+ );
+ }
+
</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>
</div>
</body>
</html>