<!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>[44254] trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php: REST API: Include fields with null schema in `get_fields_for_response()`.</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/44254">44254</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/44254","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-12-17 01:14:17 +0000 (Mon, 17 Dec 2018)</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: Include fields with null schema in `get_fields_for_response()`.
In <a href="https://core.trac.wordpress.org/changeset/43736">[43736]</a>, we prevented rendering fields when not present in `?_fields=`. However, because `get_fields_for_response()` is dependent on `get_item_schema()`, any custom fields registered with a null schema would be incorrectly excluded from the response. Because the REST API permits a null schema for `register_rest_field()`, those fields should be included in the available fields for a response.
Props danielbachhuber.
Merges <a href="https://core.trac.wordpress.org/changeset/43908">[43908]</a> to trunk.
Fixes <a href="https://core.trac.wordpress.org/ticket/45220">#45220</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#trunk">trunk/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk 2018-12-17 01:05:03 UTC (rev 44253)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk 2018-12-17 01:14:17 UTC (rev 44254)
</ins><a id="trunk"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: trunk</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/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43860,43862,43867-43883,43885-43887,43889,43892-43894,43897-43902,43904-43905,43909,43912,43926-43929,43954,43956,43961-43963,44014,44017
</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">+/branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43860,43862,43867-43883,43885-43887,43889,43892-43894,43897-43902,43904-43905,43908-43909,43912,43926-43929,43954,43956,43961-43963,44014,44017
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp"></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/endpoints/class-wp-rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2018-12-17 01:05:03 UTC (rev 44253)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2018-12-17 01:14:17 UTC (rev 44254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -519,6 +519,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_fields_for_response( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = $this->get_item_schema();
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = isset( $schema['properties'] ) ? array_keys( $schema['properties'] ) : array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $additional_fields = $this->get_additional_fields();
+ foreach ( $additional_fields as $field_name => $field_options ) {
+ // For back-compat, include any field with an empty schema
+ // because it won't be present in $this->get_item_schema().
+ if ( is_null( $field_options['schema'] ) ) {
+ $fields[] = $field_name;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $request['_fields'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $fields;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></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-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2018-12-17 01:05:03 UTC (rev 44253)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2018-12-17 01:14:17 UTC (rev 44254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3761,6 +3761,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rest_additional_fields = array();
</span><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 45220
+ */
+ public function test_get_additional_field_registration_null_schema() {
+ register_rest_field(
+ 'post',
+ 'my_custom_int',
+ array(
+ 'schema' => null,
+ 'get_callback' => array( $this, 'additional_field_get_callback' ),
+ 'update_callback' => null,
+ )
+ );
+ $post_id = $this->factory->post->create();
+
+ // 'my_custom_int' should appear because ?_fields= isn't set.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+ $response = $this->server->dispatch( $request );
+ $this->assertArrayHasKey( 'my_custom_int', $response->data );
+
+ // 'my_custom_int' should appear because it's present in ?_fields=.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+ $request->set_param( '_fields', 'title,my_custom_int' );
+ $response = $this->server->dispatch( $request );
+ $this->assertArrayHasKey( 'my_custom_int', $response->data );
+
+ // 'my_custom_int' should not appear because it's not present in ?_fields=.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+ $request->set_param( '_fields', 'title' );
+ $response = $this->server->dispatch( $request );
+ $this->assertArrayNotHasKey( 'my_custom_int', $response->data );
+
+ global $wp_rest_additional_fields;
+ $wp_rest_additional_fields = array();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_additional_field_update_errors() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'integer',
</span></span></pre>
</div>
</div>
</body>
</html>