Changeset 36632 for trunk/src/wp-includes/query.php

Timestamp:

02/23/2016 04:39:50 PM (9 years ago)

Author:

boonebgorges

Message:

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 #35692.

File:

• trunk/src/wp-includes/query.php (modified) (4 diffs)

trunk/src/wp-includes/query.php

@@ -1468 +1468 @@
      * @since 4.5.0 Removed the `$comments_popup` parameter.
      *              Introduced the `$comment_status` and `$ping_status` parameters.
+     *              Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
      * @access public
      *
@@ -1521 +1522 @@
      *                                                 Default 'date'. Accepts 'none', 'name', 'author', 'date',
      *                                                 'title', 'modified', 'menu_order', 'parent', 'ID', 'rand',
+     *                                                 'RAND(x)' (where 'x' is an integer seed value),
      *                                                 'comment_count', 'meta_value', 'meta_value_num', 'post__in',
      *                                                 and the array keys of `$meta_query`.
@@ -2333 +2335 @@
         }
 
+        // 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;
+        }
+
         if ( ! in_array( $orderby, $allowed_keys, true ) ) {
             return false;
@@ -2369 +2379 @@
                     $meta_clause = $meta_clauses[ $orderby ];
                     $orderby_clause = "CAST({$meta_clause['alias']}.meta_value AS {$meta_clause['cast']})";
+                } elseif ( $rand_with_seed ) {
+                    $orderby_clause = $orderby;
                 } else {
                     // Default: order by post field.