<!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>[53110] trunk: REST API: Use `rest_parse_embed_param` function in `WP_REST_Server` class.</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/53110">53110</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/53110","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-08 17:27:42 +0000 (Fri, 08 Apr 2022)</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: Use `rest_parse_embed_param` function in `WP_REST_Server` class.
Ensure that the value get parameter `_embed ` that is passed to the `envelope_response` method, is run through the `rest_parse_embed_param` function.
Props Spacedmonkey, johnbillion, TimothyBlynJacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/54015">#54015</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>
</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 2022-04-08 17:03:10 UTC (rev 53109)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2022-04-08 17:27:42 UTC (rev 53110)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -438,7 +438,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Wrap the response in an envelope if asked for.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_GET['_envelope'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $this->envelope_response( $result, isset( $_GET['_embed'] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $embed = isset( $_GET['_embed'] ) ? rest_parse_embed_param( $_GET['_embed'] ) : false;
+ $result = $this->envelope_response( $result, $embed );
</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"> // Send extra data from response objects.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -730,9 +731,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * data instead.
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.0.0 The $embed parameter can now contain a list of link relations to include
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Response $response Response object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $embed Whether links should be embedded.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool|string[] $embed Whether to embed all links, a filtered list of link relations, or no links.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response New response with wrapped data
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function envelope_response( $response, $embed ) {
</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 2022-04-08 17:03:10 UTC (rev 53109)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2022-04-08 17:27:42 UTC (rev 53110)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,6 +77,62 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $headers, $enveloped['headers'] );
</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">+ /**
+ * @dataProvider data_envelope_params
+ * @ticket 54015
+ */
+ public function test_envelope_param( $_embed ) {
+ // Register our testing route.
+ rest_get_server()->register_route(
+ 'test',
+ '/test/embeddable',
+ array(
+ 'methods' => 'GET',
+ 'callback' => array( $this, 'embedded_response_callback' ),
+ )
+ );
+ $data = array(
+ 'amount of arbitrary data' => 'alot',
+ );
+ $status = 987;
+ $headers = array(
+ 'Arbitrary-Header' => 'value',
+ 'Multiple' => 'maybe, yes',
+ );
+
+ $response = new WP_REST_Response( $data, $status );
+ $response->header( 'Arbitrary-Header', 'value' );
+
+ // Check header concatenation as well.
+ $response->header( 'Multiple', 'maybe' );
+ $response->header( 'Multiple', 'yes', false );
+
+ // All others should be embedded.
+ $response->add_link( 'alternate', rest_url( '/test/embeddable' ), array( 'embeddable' => true ) );
+
+ $embed = rest_parse_embed_param( $_embed );
+ $envelope_response = rest_get_server()->envelope_response( $response, $embed );
+
+ // The envelope should still be a response, but with defaults.
+ $this->assertInstanceOf( WP_REST_Response::class, $envelope_response );
+ $this->assertSame( 200, $envelope_response->get_status() );
+ $this->assertEmpty( $envelope_response->get_headers() );
+ $this->assertEmpty( $envelope_response->get_links() );
+
+ $enveloped = $envelope_response->get_data();
+
+ $this->assertArrayHasKey( 'body', $enveloped );
+ $this->assertArrayHasKey( '_links', $enveloped['body'] );
+ $this->assertArrayHasKey( '_embedded', $enveloped['body'] );
+ $this->assertArrayHasKey( 'alternate', $enveloped['body']['_embedded'] );
+
+ $alternate = $enveloped['body']['_embedded']['alternate'];
+ $this->assertCount( 1, $alternate );
+
+ $this->assertSame( $status, $enveloped['status'] );
+ $this->assertSame( $headers, $enveloped['headers'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_default_param() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> register_rest_route(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2173,4 +2229,19 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return rest_get_server()->sent_headers;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_envelope_params() {
+ return array(
+ array( '1' ),
+ array( 'true' ),
+ array( false ),
+ array( 'alternate' ),
+ array( array( 'alternate' ) ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>