<!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>[45706] trunk: REST API: Skip processing fields which are not present in the selected context.</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/45706">45706</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/45706","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>2019-07-31 20:20:02 +0000 (Wed, 31 Jul 2019)</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: Skip processing fields which are not present in the selected context.
In `WP_REST_Controller::get_fields_for_response()`, exclude fields which are not registered to appear in the request's context.
In conjunction with <a href="https://core.trac.wordpress.org/changeset/45705">r45705</a> this prevents the unnecessary computation of the sample permalink when making a request that is not context=edit.
Props dlh.
Fixes <a href="https://core.trac.wordpress.org/ticket/45605">#45605</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="#trunktestsphpunittestsrestapirestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2019-07-31 19:59:30 UTC (rev 45705)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2019-07-31 20:20:02 UTC (rev 45706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -517,8 +517,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Fields to be included in the response.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_fields_for_response( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $schema = $this->get_item_schema();
- $fields = isset( $schema['properties'] ) ? array_keys( $schema['properties'] ) : array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $schema = $this->get_item_schema();
+ $properties = isset( $schema['properties'] ) ? $schema['properties'] : array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $additional_fields = $this->get_additional_fields();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $additional_fields as $field_name => $field_options ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -525,10 +525,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // For back-compat, include any field with an empty schema
</span><span class="cx" style="display: block; padding: 0 10px"> // because it won't be present in $this->get_item_schema().
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_null( $field_options['schema'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $fields[] = $field_name;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $properties[ $field_name ] = $field_options;
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Exclude fields that specify a different context than the request context.
+ $context = $request['context'];
+ if ( $context ) {
+ foreach ( $properties as $name => $options ) {
+ if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) {
+ unset( $properties[ $name ] );
+ }
+ }
+ }
+
+ $fields = array_keys( $properties );
+
</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="trunktestsphpunittestsrestapirestcontrollerphp"></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-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-controller.php 2019-07-31 19:59:30 UTC (rev 45705)
+++ trunk/tests/phpunit/tests/rest-api/rest-controller.php 2019-07-31 20:20:02 UTC (rev 45706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -255,6 +255,94 @@
</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">+ public function test_get_fields_for_response_filters_by_context() {
+ $controller = new WP_REST_Test_Controller();
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+ $request->set_param( 'context', 'view' );
+
+ $schema = $controller->get_item_schema();
+ $field = 'somefield';
+
+ $listener = new MockAction();
+ $method = 'action';
+
+ register_rest_field(
+ $schema['title'],
+ $field,
+ array(
+ 'schema' => array(
+ 'type' => 'string',
+ 'context' => array( 'embed' ),
+ ),
+ 'get_callback' => array( $listener, $method ),
+ )
+ );
+
+ $controller->prepare_item_for_response( array(), $request );
+
+ $this->assertSame( 0, $listener->get_call_count( $method ) );
+
+ $request->set_param( 'context', 'embed' );
+
+ $controller->prepare_item_for_response( array(), $request );
+
+ $this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
+ }
+
+ public function test_filtering_fields_for_response_by_context_returns_fields_with_no_context() {
+ $controller = new WP_REST_Test_Controller();
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+ $request->set_param( 'context', 'view' );
+
+ $schema = $controller->get_item_schema();
+ $field = 'somefield';
+
+ $listener = new MockAction();
+ $method = 'action';
+
+ register_rest_field(
+ $schema['title'],
+ $field,
+ array(
+ 'schema' => array(
+ 'type' => 'string',
+ ),
+ 'get_callback' => array( $listener, $method ),
+ )
+ );
+
+ $controller->prepare_item_for_response( array(), $request );
+
+ $this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
+ }
+
+ public function test_filtering_fields_for_response_by_context_returns_fields_with_no_schema() {
+ $controller = new WP_REST_Test_Controller();
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+ $request->set_param( 'context', 'view' );
+
+ $schema = $controller->get_item_schema();
+ $field = 'somefield';
+
+ $listener = new MockAction();
+ $method = 'action';
+
+ register_rest_field(
+ $schema['title'],
+ $field,
+ array(
+ 'get_callback' => array( $listener, $method ),
+ )
+ );
+
+ $controller->prepare_item_for_response( array(), $request );
+
+ $this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_add_additional_fields_to_object_respects_fields_param() {
</span><span class="cx" style="display: block; padding: 0 10px"> $controller = new WP_REST_Test_Controller();
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
</span></span></pre>
</div>
</div>
</body>
</html>