<!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>[40605] trunk: REST API: Add `author`, `modified`, and `parent` sort order options for posts.</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 { 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/40605">40605</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/40605","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jnylen0</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-10 18:51:28 +0000 (Wed, 10 May 2017)</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 `author`, `modified`, and `parent` sort order options for posts.
These (and a few others that can be revisited later if needed) were present in
beta versions of the WP REST API but were removed during the merge to WP 4.7.
Props ChopinBach, jnylen0.
Fixes <a href="https://core.trac.wordpress.org/ticket/38693">#38693</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="#trunktestsphpunitincludestestcasephp">trunk/tests/phpunit/includes/testcase.php</a></li>
<li><a href="#trunktestsphpunittestsquerydateQueryphp">trunk/tests/phpunit/tests/query/dateQuery.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 2017-05-10 10:28:19 UTC (rev 40604)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2017-05-10 18:51:28 UTC (rev 40605)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2130,12 +2130,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => 'date',
</span><span class="cx" style="display: block; padding: 0 10px"> 'enum' => array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'author',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'date',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'relevance',
</del><span class="cx" style="display: block; padding: 0 10px"> 'id',
</span><span class="cx" style="display: block; padding: 0 10px"> 'include',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'modified',
+ 'parent',
+ 'relevance',
+ 'slug',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'title',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'slug',
</del><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></span></pre></div>
<a id="trunktestsphpunitincludestestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase.php 2017-05-10 10:28:19 UTC (rev 40604)
+++ trunk/tests/phpunit/includes/testcase.php 2017-05-10 18:51:28 UTC (rev 40605)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -868,4 +868,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
</span><span class="cx" style="display: block; padding: 0 10px"> return $id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * There's no way to change post_modified through WP functions.
+ */
+ protected function update_post_modified( $post_id, $date ) {
+ global $wpdb;
+ return $wpdb->update(
+ $wpdb->posts,
+ array(
+ 'post_modified' => $date,
+ 'post_modified_gmt' => $date,
+ ),
+ array(
+ 'ID' => $post_id,
+ ),
+ array(
+ '%s',
+ '%s',
+ ),
+ array(
+ '%d',
+ )
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsquerydateQueryphp"></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/query/dateQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/dateQuery.php 2017-05-10 10:28:19 UTC (rev 40604)
+++ trunk/tests/phpunit/tests/query/dateQuery.php 2017-05-10 18:51:28 UTC (rev 40605)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -998,30 +998,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array( $p1, $p4, $p5, );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( $expected, $q->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- /** Helpers **********************************************************/
-
- /**
- * There's no way to change post_modified through the API.
- */
- protected function update_post_modified( $post_id, $date ) {
- global $wpdb;
- return $wpdb->update(
- $wpdb->posts,
- array(
- 'post_modified' => $date,
- 'post_modified_gmt' => $date,
- ),
- array(
- 'ID' => $post_id,
- ),
- array(
- '%s',
- '%s',
- ),
- array(
- '%d',
- )
- );
- }
</del><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 2017-05-10 10:28:19 UTC (rev 40604)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2017-05-10 18:51:28 UTC (rev 40605)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,6 +267,72 @@
</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">+ public function test_get_items_orderby_author_query() {
+ $id2 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_author' => self::$editor_id ) );
+ $id3 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_author' => self::$editor_id ) );
+ $id1 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_author' => self::$author_id ) );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+ $request->set_param( 'include', array( $id1, $id2, $id3 ) );
+ $request->set_param( 'orderby', 'author' );
+
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertEquals( 200, $response->get_status() );
+ $this->assertEquals( self::$author_id, $data[0]['author'] );
+ $this->assertEquals( self::$editor_id, $data[1]['author'] );
+ $this->assertEquals( self::$editor_id, $data[2]['author'] );
+
+ $this->assertPostsOrderedBy( '{posts}.post_author DESC' );
+ }
+
+ public function test_get_items_orderby_modified_query() {
+ $id1 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+ $id3 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+ $this->update_post_modified( $id1, '2016-04-20 4:26:20' );
+ $this->update_post_modified( $id2, '2016-02-01 20:24:02' );
+ $this->update_post_modified( $id3, '2016-02-21 12:24:02' );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+ $request->set_param( 'include', array( $id1, $id2, $id3 ) );
+ $request->set_param( 'orderby', 'modified' );
+
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertEquals( 200, $response->get_status() );
+ $this->assertEquals( $id1, $data[0]['id'] );
+ $this->assertEquals( $id3, $data[1]['id'] );
+ $this->assertEquals( $id2, $data[2]['id'] );
+
+ $this->assertPostsOrderedBy( '{posts}.post_modified DESC' );
+ }
+
+ public function test_get_items_orderby_parent_query() {
+ $id1 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_type' => 'page' ) );
+ $id2 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_type' => 'page' ) );
+ $id3 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_type' => 'page', 'post_parent' => $id1 ) );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/pages' );
+ $request->set_param( 'include', array( $id1, $id2, $id3 ) );
+ $request->set_param( 'orderby', 'parent' );
+
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertEquals( 200, $response->get_status() );
+ $this->assertEquals( $id3, $data[0]['id'] );
+ // Check ordering. Default ORDER is DESC.
+ $this->assertEquals( $id1, $data[0]['parent'] );
+ $this->assertEquals( 0, $data[1]['parent'] );
+ $this->assertEquals( 0, $data[2]['parent'] );
+
+ $this->assertPostsOrderedBy( '{posts}.post_parent DESC' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_exclude_query() {
</span><span class="cx" style="display: block; padding: 0 10px"> $id1 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
</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 2017-05-10 10:28:19 UTC (rev 40604)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2017-05-10 18:51:28 UTC (rev 40605)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -226,12 +226,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><span class="cx" style="display: block; padding: 0 10px"> "default": "date",
</span><span class="cx" style="display: block; padding: 0 10px"> "enum": [
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "author",
</ins><span class="cx" style="display: block; padding: 0 10px"> "date",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "relevance",
</del><span class="cx" style="display: block; padding: 0 10px"> "id",
</span><span class="cx" style="display: block; padding: 0 10px"> "include",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "title",
- "slug"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "modified",
+ "parent",
+ "relevance",
+ "slug",
+ "title"
</ins><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Sort collection by object attribute.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string"
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -844,12 +847,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><span class="cx" style="display: block; padding: 0 10px"> "default": "date",
</span><span class="cx" style="display: block; padding: 0 10px"> "enum": [
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "author",
</ins><span class="cx" style="display: block; padding: 0 10px"> "date",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "relevance",
</del><span class="cx" style="display: block; padding: 0 10px"> "id",
</span><span class="cx" style="display: block; padding: 0 10px"> "include",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "modified",
+ "parent",
+ "relevance",
+ "slug",
</ins><span class="cx" style="display: block; padding: 0 10px"> "title",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "slug",
</del><span class="cx" style="display: block; padding: 0 10px"> "menu_order"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Sort collection by object attribute.",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1379,12 +1385,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><span class="cx" style="display: block; padding: 0 10px"> "default": "date",
</span><span class="cx" style="display: block; padding: 0 10px"> "enum": [
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "author",
</ins><span class="cx" style="display: block; padding: 0 10px"> "date",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "relevance",
</del><span class="cx" style="display: block; padding: 0 10px"> "id",
</span><span class="cx" style="display: block; padding: 0 10px"> "include",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "title",
- "slug"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "modified",
+ "parent",
+ "relevance",
+ "slug",
+ "title"
</ins><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Sort collection by object attribute.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string"
</span></span></pre>
</div>
</div>
</body>
</html>