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

Timestamp:

02/05/2015 07:37:47 PM (10 years ago)

Author:

boonebgorges

Message:

Modify `meta_query orderby syntax to use array keys as clause "handles".

The implementation of meta_query orderby introduced in [31312] put clause
identifiers into a 'name' parameter of the clause. For greater clarity, this
changeset updates the syntax to use the associative array key used when
defining meta_query parameters, instead of the 'name' parameter.

Props Funkatronic, DrewAPicture.
Fixes #31045.

File:

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

trunk/src/wp-includes/query.php

@@ -1451 +1451 @@
      *
      * @since 1.5.0
+     * @since 4.2.0 Introduced the ability to order by specific clauses of a `$meta_query`, by passing the clause's
+     *              array key to `$orderby`.
      * @access public
      *
@@ -1498 +1500 @@
      *     @type string       $order                   Designates ascending or descending order of posts. Default 'DESC'.
      *                                                 Accepts 'ASC', 'DESC'.
-     *     @type string       $orderby                 Sort retrieved posts by parameter. One or more options can be
+     *     @type string|array $orderby                 Sort retrieved posts by parameter. One or more options may be
      *                                                 passed. To use 'meta_value', or 'meta_value_num',
-     *                                                 'meta_key=keyname' must be also be defined. Default 'date'.
-     *                                                 Accepts 'none', 'name', 'author', 'date', 'title', 'modified',
-     *                                                 'menu_order', 'parent', 'ID', 'rand', 'comment_count'.
+     *                                                 'meta_key=keyname' must be also be defined. To sort by a
+     *                                                 specific `$meta_query` clause, use that clause's array key.
+     *                                                 Default 'date'. Accepts 'none', 'name', 'author', 'date',
+     *                                                 'title', 'modified', 'menu_order', 'parent', 'ID', 'rand',
+     *                                                 'comment_count', 'meta_value', 'meta_value_num', and the
+     *                                                 array keys of `$meta_query`.
      *     @type int          $p                       Post ID.
      *     @type int          $page                    Show the number of posts that would show up on page X of a