<!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>[46646] trunk: REST API: Add tax relation parameter to posts collection.</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/46646">46646</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/46646","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>2019-11-03 23:12:44 +0000 (Sun, 03 Nov 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: Add tax relation parameter to posts collection.
The REST API supports filtering by terms across multiple taxonomies using an AND relation. This adds support for an OR relation by adding "tax_relation=OR" as a query parameter.
Props earnjam.
Fixes <a href="https://core.trac.wordpress.org/ticket/44326">#44326</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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-posts-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-posts-controller.php 2019-11-03 22:47:52 UTC (rev 46645)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2019-11-03 23:12:44 UTC (rev 46646)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -270,6 +270,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $request['tax_relation'] ) ) {
+ $query_args['tax_query'] = array( 'relation' => $request['tax_relation'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
</span><span class="cx" style="display: block; padding: 0 10px"> $tax_exclude = $base . '_exclude';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2531,6 +2535,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $taxonomies ) ) {
+ $query_params['tax_relation'] = array(
+ 'description' => __( 'Limit result set based on relationship between multiple taxonomies.' ),
+ 'type' => 'string',
+ 'enum' => array( 'AND', 'OR' ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></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-posts-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-posts-controller.php 2019-11-03 22:47:52 UTC (rev 46645)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2019-11-03 23:12:44 UTC (rev 46646)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,6 +175,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'sticky',
</span><span class="cx" style="display: block; padding: 0 10px"> 'tags',
</span><span class="cx" style="display: block; padding: 0 10px"> 'tags_exclude',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'tax_relation',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $keys
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -959,6 +960,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
</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 44326
+ */
+ public function test_get_items_tags_or_categories_query() {
+ $id1 = self::$post_id;
+ $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $id3 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $id4 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $tag = wp_insert_term( 'My Tag', 'post_tag' );
+ $category = wp_insert_term( 'My Category', 'category' );
+
+ wp_set_object_terms( $id1, array( $tag['term_id'] ), 'post_tag' );
+ wp_set_object_terms( $id2, array( $category['term_id'] ), 'category' );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+ $request->set_param( 'tax_relation', 'OR' );
+ $request->set_param( 'tags', array( $tag['term_id'] ) );
+ $request->set_param( 'categories', array( $category['term_id'] ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertCount( 2, $data );
+ $this->assertEquals( $id2, $data[0]['id'] );
+ $this->assertEquals( $id1, $data[1]['id'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_tags_and_categories_exclude_query() {
</span><span class="cx" style="display: block; padding: 0 10px"> $id1 = self::$post_id;
</span><span class="cx" style="display: block; padding: 0 10px"> $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -985,6 +1012,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
</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 44326
+ */
+ public function test_get_items_tags_or_categories_exclude_query() {
+ $id1 = self::$post_id;
+ $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $id3 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $id4 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $tag = wp_insert_term( 'My Tag', 'post_tag' );
+ $category = wp_insert_term( 'My Category', 'category' );
+
+ wp_set_object_terms( $id1, array( $tag['term_id'] ), 'post_tag' );
+ wp_set_object_terms( $id2, array( $tag['term_id'] ), 'post_tag' );
+ wp_set_object_terms( $id2, array( $category['term_id'] ), 'category' );
+ wp_set_object_terms( $id3, array( $category['term_id'] ), 'category' );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+ $request->set_param( 'tags', array( $tag['term_id'] ) );
+ $request->set_param( 'categories_exclude', array( $category['term_id'] ) );
+ $request->set_param( 'tax_relation', 'OR' );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertCount( 3, $data );
+ $this->assertEquals( $id2, $data[0]['id'] );
+ $this->assertEquals( $id4, $data[1]['id'] );
+ $this->assertEquals( $id1, $data[2]['id'] );
+ }
+
+ /**
+ * @ticket 44326
+ */
+ public function test_get_items_relation_with_no_tax_query() {
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+ $request->set_param( 'tax_relation', 'OR' );
+ $request->set_param( 'include', self::$post_id );
+
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $this->assertCount( 1, $response->get_data() );
+ $this->assertEquals( self::$post_id, $response->get_data()[0]['id'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_sticky() {
</span><span class="cx" style="display: block; padding: 0 10px"> $id1 = self::$post_id;
</span><span class="cx" style="display: block; padding: 0 10px"> $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2019-11-03 22:47:52 UTC (rev 46645)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2019-11-03 23:12:44 UTC (rev 46646)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -322,6 +322,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string"
</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">+ "tax_relation": {
+ "required": false,
+ "enum": [
+ "AND",
+ "OR"
+ ],
+ "description": "Limit result set based on relationship between multiple taxonomies.",
+ "type": "string"
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "categories": {
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span></span></pre>
</div>
</div>
</body>
</html>