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.

Built from https://develop.svn.wordpress.org/trunk@34361


git-svn-id: http://core.svn.wordpress.org/trunk@34325 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-21 00:47:25 +00:00
parent f38013229b
commit e6764f3b19
2 changed files with 7 additions and 6 deletions

View File

@ -79,6 +79,7 @@ class WP_User_Query {
* Prepare the query variables. * Prepare the query variables.
* *
* @since 3.1.0 * @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 * @since 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax
* for `$orderby` parameter. * for `$orderby` parameter.
* @since 4.3.0 Added 'has_published_posts' parameter. * @since 4.3.0 Added 'has_published_posts' parameter.
@ -108,11 +109,11 @@ class WP_User_Query {
* @type string|array $orderby Field(s) to sort the retrieved users by. May be a single value, * @type string|array $orderby Field(s) to sort the retrieved users by. May be a single value,
* an array of values, or a multi-dimensional array with fields as * an array of values, or a multi-dimensional array with fields as
* keys and orders ('ASC' or 'DESC') as values. Accepted values are * keys and orders ('ASC' or 'DESC') as values. Accepted values are
* 'ID', 'display_name' (or 'name'), 'user_login' (or 'login'), * 'ID', 'display_name' (or 'name'), 'include', 'user_login'
* 'user_nicename' (or 'nicename'), 'user_email' (or 'email'), * (or 'login'), 'user_nicename' (or 'nicename'), 'user_email'
* 'user_url' (or 'url'), 'user_registered' (or 'registered'), * (or 'email'), 'user_url' (or 'url'), 'user_registered'
* 'post_count', 'meta_value', 'meta_value_num', the value of * or 'registered'), 'post_count', 'meta_value', 'meta_value_num',
* `$meta_key`, or an array key of `$meta_query`. To use * 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 * 'meta_value' or 'meta_value_num', `$meta_key` must be also be
* defined. Default 'user_login'. * defined. Default 'user_login'.
* @type string $order Designates ascending or descending order of users. Order values * @type string $order Designates ascending or descending order of users. Order values

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-34360'; $wp_version = '4.4-alpha-34361';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.