<!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>[44452] trunk: Query: Standardize treatment of 'orderby' values `post__in`, `post_parent__in`, and `post_name__in`.</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/44452">44452</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/44452","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-01-08 03:32:04 +0000 (Tue, 08 Jan 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'>Query: Standardize treatment of 'orderby' values `post__in`, `post_parent__in`, and `post_name__in`.
Ordering by `post__in` was introduced in <a href="https://core.trac.wordpress.org/changeset/21776">[21776]</a>, but the code assumed that
`post__in` would be a comma-separated string listing post IDs. When an array
of post IDs was passed to the `post__in` query var, 'orderby=post__in' was
not respected. This changeset changes this behavior by handling
'orderby=post__in' in the same way as most other values of 'orderby',
which ensures that arrays as well as strings can be properly parsed.
The same treatment is given to the similar `post_name__in` and
`post_parent__in` options of 'orderby', so that most query generation for
orderby clauses happens in the same place, instead of in special cases.
A slight change in the resulting SQL (related to the whitespace around
parentheses and commas) necessitates a change to an existing REST API test
that does a string comparison against the SQL query.
Props mgibbs189, kelvink.
Fixes <a href="https://core.trac.wordpress.org/ticket/38034">#38034</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
<li><a href="#trunktestsphpunittestspostqueryphp">trunk/tests/phpunit/tests/post/query.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpqueryphp"></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/class-wp-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php 2019-01-08 03:28:15 UTC (rev 44451)
+++ trunk/src/wp-includes/class-wp-query.php 2019-01-08 03:32:04 UTC (rev 44452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1546,6 +1546,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'menu_order',
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_count',
</span><span class="cx" style="display: block; padding: 0 10px"> 'rand',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post__in',
+ 'post_parent__in',
+ 'post_name__in',
</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"> $primary_meta_key = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1576,6 +1579,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ $orderby_clause = '';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $orderby ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'post_name':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'post_author':
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1603,6 +1608,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case 'meta_value_num':
</span><span class="cx" style="display: block; padding: 0 10px"> $orderby_clause = "{$primary_meta_query['alias']}.meta_value+0";
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'post__in':
+ if ( ! empty( $this->query_vars['post__in'] ) ) {
+ $orderby_clause = "FIELD({$wpdb->posts}.ID," . implode( ',', array_map( 'absint', $this->query_vars['post__in'] ) ) . ')';
+ }
+ break;
+ case 'post_parent__in':
+ if ( ! empty( $this->query_vars['post_parent__in'] ) ) {
+ $orderby_clause = "FIELD( {$wpdb->posts}.post_parent," . implode( ', ', array_map( 'absint', $this->query_vars['post_parent__in'] ) ) . ' )';
+ }
+ break;
+ case 'post_name__in':
+ if ( ! empty( $this->query_vars['post_name__in'] ) ) {
+ $post_name__in = array_map( 'sanitize_title_for_query', $this->query_vars['post_name__in'] );
+ $post_name__in_string = "'" . implode( "','", $post_name__in ) . "'";
+ $orderby_clause = "FIELD( {$wpdb->posts}.post_name," . $post_name__in_string . ' )';
+ }
+ break;
</ins><span class="cx" style="display: block; padding: 0 10px"> default:
</span><span class="cx" style="display: block; padding: 0 10px"> if ( array_key_exists( $orderby, $meta_clauses ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // $orderby corresponds to a meta_query clause.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2239,6 +2261,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $q['order'] = $rand ? '' : $this->parse_order( $q['order'] );
</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">+ // These values of orderby should ignore the 'order' parameter.
+ $force_asc = array( 'post__in', 'post_name__in', 'post_parent__in' );
+ if ( isset( $q['orderby'] ) && in_array( $q['orderby'], $force_asc, true ) ) {
+ $q['order'] = '';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Order by.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $q['orderby'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2252,12 +2280,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'none' == $q['orderby'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $orderby = '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( $q['orderby'] == 'post__in' && ! empty( $post__in ) ) {
- $orderby = "FIELD( {$wpdb->posts}.ID, $post__in )";
- } elseif ( $q['orderby'] == 'post_parent__in' && ! empty( $post_parent__in ) ) {
- $orderby = "FIELD( {$wpdb->posts}.post_parent, $post_parent__in )";
- } elseif ( $q['orderby'] == 'post_name__in' && ! empty( $post_name__in ) ) {
- $orderby = "FIELD( {$wpdb->posts}.post_name, $post_name__in )";
</del><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $orderby_array = array();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $q['orderby'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestspostqueryphp"></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/post/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/query.php 2019-01-08 03:28:15 UTC (rev 44451)
+++ trunk/tests/phpunit/tests/post/query.php 2019-01-08 03:32:04 UTC (rev 44452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,6 +174,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $ordered, wp_list_pluck( $q->posts, 'ID' ) );
</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 38034
+ */
+ public function test_orderby_post__in_array() {
+ $posts = self::factory()->post->create_many( 4 );
+
+ $ordered = array( $posts[2], $posts[0], $posts[3] );
+
+ $q = new WP_Query( array(
+ 'post_type' => 'any',
+ 'post__in' => $ordered,
+ 'orderby' => array( 'post__in' => 'ASC' ),
+ ) );
+ $this->assertSame( $ordered, wp_list_pluck( $q->posts, 'ID' ) );
+ }
+
+ /**
+ * @ticket 38034
+ */
+ public function test_orderby_post__in_array_with_implied_order() {
+ $posts = self::factory()->post->create_many( 4 );
+
+ $ordered = array( $posts[2], $posts[0], $posts[3] );
+
+ $q = new WP_Query( array(
+ 'post_type' => 'any',
+ 'post__in' => $ordered,
+ 'orderby' => 'post__in',
+ ) );
+ $this->assertSame( $ordered, wp_list_pluck( $q->posts, 'ID' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_post__in_attachment_ordering() {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $att_ids = array();
</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-01-08 03:28:15 UTC (rev 44451)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2019-01-08 03:32:04 UTC (rev 44452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -291,7 +291,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 2, count( $data ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id1, $data[0]['id'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertPostsOrderedBy( "FIELD( {posts}.ID, $id1,$id3 )" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( "FIELD({posts}.ID,$id1,$id3)" );
</ins><span class="cx" style="display: block; padding: 0 10px"> // Invalid include should error
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'include', 'invalid' );
</span></span></pre>
</div>
</div>
</body>
</html>