<!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>[50005] trunk: REST API: Support embedding links in `rest_preload_api_request()`.</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/50005">50005</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/50005","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>2021-01-23 23:25:40 +0000 (Sat, 23 Jan 2021)</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: Support embedding links in `rest_preload_api_request()`.
Props lpawlik, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/51722">#51722</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 2021-01-23 13:13:04 UTC (rev 50004)
+++ trunk/src/wp-includes/rest-api.php 2021-01-23 23:25:40 UTC (rev 50005)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2520,11 +2520,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 200 === $response->status ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $server = rest_get_server();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = (array) $response->get_data();
- $links = $server::get_compact_response_links( $response );
- if ( ! empty( $links ) ) {
- $data['_links'] = $links;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $embed = $request->has_param( '_embed' ) ? rest_parse_embed_param( $request['_embed'] ) : false;
+ $data = (array) $server->response_to_data( $response, $embed );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'OPTIONS' === $method ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_send_allow_header( $response, $server, $request );
</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 2021-01-23 13:13:04 UTC (rev 50004)
+++ trunk/tests/phpunit/tests/rest-api.php 2021-01-23 23:25:40 UTC (rev 50005)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2328,4 +2328,56 @@
</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">+
+ /**
+ * @ticket 51722
+ * @dataProvider data_rest_preload_api_request_embeds_links
+ *
+ * @param string $embed The embed parameter.
+ * @param string[] $expected The list of link relations that should be embedded.
+ * @param string[] $not_expected The list of link relations that should not be embedded.
+ */
+ public function test_rest_preload_api_request_embeds_links( $embed, $expected, $not_expected ) {
+ wp_set_current_user( 1 );
+ $post_id = self::factory()->post->create();
+ self::factory()->comment->create_post_comments( $post_id );
+
+ $url = sprintf( '/wp/v2/posts/%d?%s', $post_id, $embed );
+ $preload_paths = array( $url );
+
+ $preload_data = array_reduce(
+ $preload_paths,
+ 'rest_preload_api_request',
+ array()
+ );
+
+ $this->assertSame( array_keys( $preload_data ), $preload_paths );
+ $this->assertArrayHasKey( 'body', $preload_data[ $url ] );
+ $this->assertArrayHasKey( '_links', $preload_data[ $url ]['body'] );
+
+ if ( $expected ) {
+ $this->assertArrayHasKey( '_embedded', $preload_data[ $url ]['body'] );
+ } else {
+ $this->assertArrayNotHasKey( '_embedded', $preload_data[ $url ]['body'] );
+ }
+
+ foreach ( $expected as $rel ) {
+ $this->assertArrayHasKey( $rel, $preload_data[ $url ]['body']['_embedded'] );
+ }
+
+ foreach ( $not_expected as $rel ) {
+ $this->assertArrayNotHasKey( $rel, $preload_data[ $url ]['body']['_embedded'] );
+ }
+ }
+
+ public function data_rest_preload_api_request_embeds_links() {
+ return array(
+ array( '_embed=wp:term,author', array( 'wp:term', 'author' ), array( 'replies' ) ),
+ array( '_embed[]=wp:term&_embed[]=author', array( 'wp:term', 'author' ), array( 'replies' ) ),
+ array( '_embed', array( 'wp:term', 'author', 'replies' ), array() ),
+ array( '_embed=1', array( 'wp:term', 'author', 'replies' ), array() ),
+ array( '_embed=true', array( 'wp:term', 'author', 'replies' ), array() ),
+ array( '', array(), array() ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>