sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

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

Props danielbachhuber.
Fixes #33937.


git-svn-id: https://develop.svn.wordpress.org/trunk@34361 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-21 00:46:08 +00:00
parent f80add733c
commit 71ce9e812c
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wp-includes/class-wp-user-query.php
View File

@ -79,6 +79,7 @@ class WP_User_Query {
* Prepare the query variables.
*
* @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.
* @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,
* 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'.
* @type string $order Designates ascending or descending order of users. Order values