<!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>[36632] trunk: Query: Allow a seed value to be passed when using 'rand' `$orderby`.</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/36632">36632</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/36632","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>2016-02-23 16:39:50 +0000 (Tue, 23 Feb 2016)</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: Allow a seed value to be passed when using 'rand' `$orderby`.
`WP_Query` allows random ordering; `'orderby' => 'rand'` translates to
`ORDER BY RAND()`. This syntax results in random ordering that is not
consistent from request to request. MySQL supports the passing of a seed value
to random sorts, such as `ORDER BY RAND(3)`, which will return the same
random value each time it's called. `WP_Query` now supports this syntax, by
passing `RAND(3)` (or whatever integer seed value you'd like) as the value
of `'orderby'`.
Props hlashbrooke.
Fixes <a href="https://core.trac.wordpress.org/ticket/35692">#35692</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesqueryphp">trunk/src/wp-includes/query.php</a></li>
<li><a href="#trunktestsphpunittestspostqueryphp">trunk/tests/phpunit/tests/post/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/query.php 2016-02-23 16:27:36 UTC (rev 36631)
+++ trunk/src/wp-includes/query.php 2016-02-23 16:39:50 UTC (rev 36632)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1467,6 +1467,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * search terms, by prepending a hyphen.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0 Removed the `$comments_popup` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced the `$comment_status` and `$ping_status` parameters.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $query {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1520,6 +1521,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * specific `$meta_query` clause, use that clause's array key.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'date'. Accepts 'none', 'name', 'author', 'date',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'title', 'modified', 'menu_order', 'parent', 'ID', 'rand',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'RAND(x)' (where 'x' is an integer seed value),
</ins><span class="cx" style="display: block; padding: 0 10px"> * 'comment_count', 'meta_value', 'meta_value_num', 'post__in',
</span><span class="cx" style="display: block; padding: 0 10px"> * and the array keys of `$meta_query`.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $p Post ID.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2332,6 +2334,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $allowed_keys = array_merge( $allowed_keys, array_keys( $meta_clauses ) );
</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">+ // If RAND() contains a seed value, sanitize and add to allowed keys.
+ $rand_with_seed = false;
+ if ( preg_match( '/RAND\(([0-9]+)\)/i', $orderby, $matches ) ) {
+ $orderby = sprintf( 'RAND(%s)', intval( $matches[1] ) );
+ $allowed_keys[] = $orderby;
+ $rand_with_seed = true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $orderby, $allowed_keys, true ) ) {
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -2368,6 +2378,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // $orderby corresponds to a meta_query clause.
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_clause = $meta_clauses[ $orderby ];
</span><span class="cx" style="display: block; padding: 0 10px"> $orderby_clause = "CAST({$meta_clause['alias']}.meta_value AS {$meta_clause['cast']})";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $rand_with_seed ) {
+ $orderby_clause = $orderby;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // Default: order by post field.
</span><span class="cx" style="display: block; padding: 0 10px"> $orderby_clause = "$wpdb->posts.post_" . sanitize_key( $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 2016-02-23 16:27:36 UTC (rev 36631)
+++ trunk/tests/phpunit/tests/post/query.php 2016-02-23 16:39:50 UTC (rev 36632)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,6 +304,39 @@
</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 35692
+ */
+ public function test_orderby_rand_with_seed() {
+ $q = new WP_Query( array(
+ 'orderby' => 'RAND(5)',
+ ) );
+
+ $this->assertContains( 'ORDER BY RAND(5)', $q->request );
+ }
+
+ /**
+ * @ticket 35692
+ */
+ public function test_orderby_rand_should_ignore_invalid_seed() {
+ $q = new WP_Query( array(
+ 'orderby' => 'RAND(foo)',
+ ) );
+
+ $this->assertNotContains( 'ORDER BY RAND', $q->request );
+ }
+
+ /**
+ * @ticket 35692
+ */
+ public function test_orderby_rand_with_seed_should_be_case_insensitive() {
+ $q = new WP_Query( array(
+ 'orderby' => 'rand(5)',
+ ) );
+
+ $this->assertContains( 'ORDER BY RAND(5)', $q->request );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests the post_name__in attribute of WP_Query.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 33065
</span></span></pre>
</div>
</div>
</body>
</html>