<!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>[47224] trunk: REST API: Introduce selective link embedding.</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/47224">47224</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/47224","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-02-09 20:52:06 +0000 (Sun, 09 Feb 2020)</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: Introduce selective link embedding.
Previously the _embed flag would embed all embeddable links in a response even if only a subset of the links were necessary. Now, a list of link relations can be passed in the _embed parameter to restrict the list of embedded objects.
Props rheinardkorf, adamsilverstein, jnylen0, cklosows, chrisvanpatten, TimothyBlynJacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/39696">#39696</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="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestserverphp">trunk/tests/phpunit/tests/rest-api/rest-server.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="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 2020-02-09 20:42:26 UTC (rev 47223)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2020-02-09 20:52:06 UTC (rev 47224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -398,7 +398,8 @@
</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"> // Embed links inside the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $this->response_to_data( $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->response_to_data( $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"> * Filters the API response.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -450,9 +451,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Converts a response to data to send.
</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 5.4.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 array {
</span><span class="cx" style="display: block; padding: 0 10px"> * Data with sub-requests embedded.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -473,9 +475,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->embed_cache = array();
</span><span class="cx" style="display: block; padding: 0 10px"> // Determine if this is a numeric array.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_is_numeric_array( $data ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = array_map( array( $this, 'embed_links' ), $data );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $data as $key => $item ) {
+ $data[ $key ] = $this->embed_links( $item, $embed );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = $this->embed_links( $data );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data = $this->embed_links( $data, $embed );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->embed_cache = array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -571,8 +575,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Embeds the links from the data into the request.
</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 5.4.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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $data Data from the request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Data from the request.
+ * @param bool|string[] $embed Whether to embed all links or a filtered list of link relations.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * Data with sub-requests embedded.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -580,7 +586,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array [$_embedded] Embeddeds.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function embed_links( $data ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function embed_links( $data, $embed = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $data['_links'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,6 +594,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $embedded = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $data['_links'] as $rel => $links ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If a list of relations was specified, and the link relation is not in the whitelist, don't process the link.
+ if ( is_array( $embed ) && ! in_array( $rel, $embed, true ) ) {
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $embeds = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $links as $item ) {
</span></span></pre></div>
<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 2020-02-09 20:42:26 UTC (rev 47223)
+++ trunk/src/wp-includes/rest-api.php 2020-02-09 20:52:06 UTC (rev 47224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1571,3 +1571,25 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $memo;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Parses the "_embed" parameter into the list of resources to embed.
+ *
+ * @since 5.4.0
+ *
+ * @param string|array $embed Raw "_embed" parameter value.
+ * @return true|string[] Either true to embed all embeds, or a list of relations to embed.
+ */
+function rest_parse_embed_param( $embed ) {
+ if ( ! $embed || 'true' === $embed || '1' === $embed ) {
+ return true;
+ }
+
+ $rels = wp_parse_list( $embed );
+
+ if ( ! $rels ) {
+ return true;
+ }
+
+ return $rels;
+}
</ins></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 2020-02-09 20:42:26 UTC (rev 47223)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2020-02-09 20:52:06 UTC (rev 47224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -845,6 +845,66 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $self_not_filtered, $data['_links']['self'][0] );
</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 _dp_response_to_data_embedding
+ */
+ public function test_response_to_data_embedding( $expected, $embed ) {
+ $response = new WP_REST_Response();
+ $response->add_link( 'author', rest_url( '404' ), array( 'embeddable' => true ) );
+ $response->add_link( 'https://api.w.org/term', rest_url( '404' ), array( 'embeddable' => true ) );
+ $response->add_link( 'https://wordpress.org', rest_url( '404' ), array( 'embeddable' => true ) );
+ $response->add_link( 'no-embed', rest_url( '404' ) );
+
+ $data = rest_get_server()->response_to_data( $response, $embed );
+
+ if ( false === $expected ) {
+ $this->assertArrayNotHasKey( '_embedded', $data );
+ } else {
+ $this->assertEqualSets( $expected, array_keys( $data['_embedded'] ) );
+ }
+ }
+
+ public function _dp_response_to_data_embedding() {
+ return array(
+ array(
+ array( 'author', 'wp:term', 'https://wordpress.org' ),
+ true,
+ ),
+ array(
+ array( 'author', 'wp:term', 'https://wordpress.org' ),
+ array( 'author', 'wp:term', 'https://wordpress.org' ),
+ ),
+ array(
+ array( 'author' ),
+ array( 'author' ),
+ ),
+ array(
+ array( 'wp:term' ),
+ array( 'wp:term' ),
+ ),
+ array(
+ array( 'https://wordpress.org' ),
+ array( 'https://wordpress.org' ),
+ ),
+ array(
+ array( 'author', 'wp:term' ),
+ array( 'author', 'wp:term' ),
+ ),
+ array(
+ false,
+ false,
+ ),
+ array(
+ false,
+ array( 'no-embed' ),
+ ),
+ array(
+ array( 'author' ),
+ array( 'author', 'no-embed' ),
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_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>
<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 2020-02-09 20:42:26 UTC (rev 47223)
+++ trunk/tests/phpunit/tests/rest-api.php 2020-02-09 20:52:06 UTC (rev 47224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -906,4 +906,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '/wp/v2/posts', $request->get_route() );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'GET', $request->get_method() );
</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 _dp_rest_parse_embed_param
+ */
+ public function test_rest_parse_embed_param( $expected, $embed ) {
+ $this->assertEquals( $expected, rest_parse_embed_param( $embed ) );
+ }
+
+ public function _dp_rest_parse_embed_param() {
+ return array(
+ array( true, '' ),
+ array( true, null ),
+ array( true, '1' ),
+ array( true, 'true' ),
+ array( true, array() ),
+ array( array( 'author' ), 'author' ),
+ array( array( 'author', 'replies' ), 'author,replies' ),
+ array( array( 'author', 'replies' ), 'author,replies ' ),
+ array( array( 'wp:term' ), 'wp:term' ),
+ array( array( 'wp:term', 'wp:attachment' ), 'wp:term,wp:attachment' ),
+ array( array( 'author' ), array( 'author' ) ),
+ array( array( 'author', 'replies' ), array( 'author', 'replies' ) ),
+ array( array( 'https://api.w.org/term' ), 'https://api.w.org/term' ),
+ array( array( 'https://api.w.org/term', 'https://api.w.org/attachment' ), 'https://api.w.org/term,https://api.w.org/attachment' ),
+ array( array( 'https://api.w.org/term', 'https://api.w.org/attachment' ), array( 'https://api.w.org/term', 'https://api.w.org/attachment' ) ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>