<!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>[41744] trunk: REST API: Add _fields parameter to selectively include fields in response JSON.</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 { 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/41744">41744</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/41744","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-04 18:44:41 +0000 (Wed, 04 Oct 2017)</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: Add _fields parameter to selectively include fields in response JSON.
Allows REST API consumers to specify the specific fields needed in their application code, whitelisting those fields and omitting all others from the returned JSON response object.
This permits applications that only need for example the ID and title of posts to avoid having to transfer the entire rendered post content over the wire alongside the desired fields.
While this whitelisting has no affect on the queries run when preparing the response, it can yield significant reductions in the bandwidth required to transfer a response payload for simple applications.
Props adamsilverstein, TimothyBlynJacobs, svrooij.
Fixes <a href="https://core.trac.wordpress.org/ticket/38131">#38131</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiphp">trunk/tests/phpunit/tests/rest-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2017-10-04 18:44:36 UTC (rev 41743)
+++ trunk/src/wp-includes/rest-api.php 2017-10-04 18:44:41 UTC (rev 41744)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,6 +165,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Default serving.
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'rest_pre_serve_request', 'rest_send_cors_headers' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'rest_post_dispatch', 'rest_send_allow_header', 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'rest_pre_dispatch', 'rest_handle_options_request', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -633,6 +634,49 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the API response to include only a white-listed set of response object fields.
+ *
+ * @since 4.8.0
+ *
+ * @param WP_REST_Response $response Current response being served.
+ * @param WP_REST_Server $server ResponseHandler instance (usually WP_REST_Server).
+ * @param WP_REST_Request $request The request that was used to make current response.
+ *
+ * @return WP_REST_Response Response to be served, trimmed down to contain a subset of fields.
+ */
+function rest_filter_response_fields( $response, $server, $request ) {
+ if ( ! isset( $request['_fields'] ) || $response->is_error() ) {
+ return $response;
+ }
+
+ $data = $response->get_data();
+
+ $fields = is_array( $request['_fields'] ) ? $request['_fields'] : preg_split( '/[\s,]+/', $request['_fields'] );
+
+ if ( 0 === count( $fields ) ) {
+ return $response;
+ }
+
+ // Trim off outside whitespace from the comma delimited list.
+ $fields = array_map( 'trim', $fields );
+
+ $fields_as_keyed = array_combine( $fields, array_fill( 0, count( $fields ), true ) );
+
+ if ( wp_is_numeric_array( $data ) ) {
+ $new_data = array();
+ foreach ( $data as $item ) {
+ $new_data[] = array_intersect_key( $item, $fields_as_keyed );
+ }
+ } else {
+ $new_data = array_intersect_key( $data, $fields_as_keyed );
+ }
+
+ $response->set_data( $new_data );
+
+ return $response;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Adds the REST API URL to the WP RSD endpoint.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api.php 2017-10-04 18:44:36 UTC (rev 41743)
+++ trunk/tests/phpunit/tests/rest-api.php 2017-10-04 18:44:41 UTC (rev 41744)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -305,6 +305,131 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensure that result fields are not whitelisted if no request['_fields'] is present.
+ */
+ public function test_rest_filter_response_fields_no_request_filter() {
+ $response = new WP_REST_Response();
+ $response->set_data( array( 'a' => true ) );
+ $request = array();
+
+ $response = rest_filter_response_fields( $response, null, $request );
+ $this->assertEquals( array( 'a' => true ), $response->get_data() );
+ }
+
+ /**
+ * Ensure that result fields are whitelisted if request['_fields'] is present.
+ */
+ public function test_rest_filter_response_fields_single_field_filter() {
+ $response = new WP_REST_Response();
+ $response->set_data( array(
+ 'a' => 0,
+ 'b' => 1,
+ 'c' => 2,
+ ) );
+ $request = array(
+ '_fields' => 'b'
+ );
+
+ $response = rest_filter_response_fields( $response, null, $request );
+ $this->assertEquals( array( 'b' => 1 ), $response->get_data() );
+ }
+
+ /**
+ * Ensure that multiple comma-separated fields may be whitelisted with request['_fields'].
+ */
+ public function test_rest_filter_response_fields_multi_field_filter() {
+ $response = new WP_REST_Response();
+ $response->set_data( array(
+ 'a' => 0,
+ 'b' => 1,
+ 'c' => 2,
+ 'd' => 3,
+ 'e' => 4,
+ 'f' => 5,
+ ) );
+ $request = array(
+ '_fields' => 'b,c,e'
+ );
+
+ $response = rest_filter_response_fields( $response, null, $request );
+ $this->assertEquals( array(
+ 'b' => 1,
+ 'c' => 2,
+ 'e' => 4,
+ ), $response->get_data() );
+ }
+
+ /**
+ * Ensure that multiple comma-separated fields may be whitelisted
+ * with request['_fields'] using query parameter array syntax.
+ */
+ public function test_rest_filter_response_fields_multi_field_filter_array() {
+ $response = new WP_REST_Response();
+
+ $response->set_data( array(
+ 'a' => 0,
+ 'b' => 1,
+ 'c' => 2,
+ 'd' => 3,
+ 'e' => 4,
+ 'f' => 5,
+ ) );
+ $request = array(
+ '_fields' => array( 'b', 'c', 'e' )
+ );
+
+ $response = rest_filter_response_fields( $response, null, $request );
+ $this->assertEquals( array(
+ 'b' => 1,
+ 'c' => 2,
+ 'e' => 4,
+ ), $response->get_data() );
+ }
+
+ /**
+ * Ensure that request['_fields'] whitelists apply to items in response collections.
+ */
+ public function test_rest_filter_response_fields_numeric_array() {
+ $response = new WP_REST_Response();
+ $response->set_data( array(
+ array(
+ 'a' => 0,
+ 'b' => 1,
+ 'c' => 2,
+ ),
+ array(
+ 'a' => 3,
+ 'b' => 4,
+ 'c' => 5,
+ ),
+ array(
+ 'a' => 6,
+ 'b' => 7,
+ 'c' => 8,
+ ),
+ ) );
+ $request = array(
+ '_fields' => 'b,c'
+ );
+
+ $response = rest_filter_response_fields( $response, null, $request );
+ $this->assertEquals( array(
+ array(
+ 'b' => 1,
+ 'c' => 2,
+ ),
+ array(
+ 'b' => 4,
+ 'c' => 5,
+ ),
+ array(
+ 'b' => 7,
+ 'c' => 8,
+ ),
+ ), $response->get_data() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * The get_rest_url function should return a URL consistently terminated with a "/",
</span><span class="cx" style="display: block; padding: 0 10px"> * whether the blog is configured with pretty permalink support or not.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>