Changeset 34361

Timestamp:

09/21/2015 12:46:08 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Update the docs for WP_User_Query->prepare_query() for ordering by the value of the include argument, allowed since 4.1.

Also adds a changelog entry for the additionally-accepted value.

Props danielbachhuber.
Fixes #33937.

File:

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

trunk/src/wp-includes/class-wp-user-query.php

@@ -80 +80 @@
      *
      * @since 3.1.0
+     * @since 4.1.0 Added the ability to order by the `include` value.
      * @since 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax
      *              for `$orderby` parameter.
@@ -109 +110 @@
      *                                             an array of values, or a multi-dimensional array with fields as
      *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
-     *                                             'ID', 'display_name' (or 'name'), 'user_login' (or 'login'),
-     *                                             'user_nicename' (or 'nicename'), 'user_email' (or 'email'),
-     *                                             'user_url' (or 'url'), 'user_registered' (or 'registered'),
-     *                                             'post_count', 'meta_value', 'meta_value_num', the value of
-     *                                             `$meta_key`, or an array key of `$meta_query`. To use
+     *                                             'ID', 'display_name' (or 'name'), 'include', 'user_login'
+     *                                             (or 'login'), 'user_nicename' (or 'nicename'), 'user_email'
+     *                                             (or 'email'), 'user_url' (or 'url'), 'user_registered'
+     *                                             or 'registered'), 'post_count', 'meta_value', 'meta_value_num',
+     *                                             the value of `$meta_key`, or an array key of `$meta_query`. To use
      *                                             'meta_value' or 'meta_value_num', `$meta_key` must be also be
      *                                             defined. Default 'user_login'.