WordPress.org

Make WordPress Core

Changeset 34361


Ignore:
Timestamp:
09/21/2015 12:46:08 AM (5 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-user-query.php

    r33895 r34361  
    8080     *
    8181     * @since 3.1.0
     82     * @since 4.1.0 Added the ability to order by the `include` value.
    8283     * @since 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax
    8384     *              for `$orderby` parameter.
     
    109110     *                                             an array of values, or a multi-dimensional array with fields as
    110111     *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
    111      *                                             'ID', 'display_name' (or 'name'), 'user_login' (or 'login'),
    112      *                                             'user_nicename' (or 'nicename'), 'user_email' (or 'email'),
    113      *                                             'user_url' (or 'url'), 'user_registered' (or 'registered'),
    114      *                                             'post_count', 'meta_value', 'meta_value_num', the value of
    115      *                                             `$meta_key`, or an array key of `$meta_query`. To use
     112     *                                             'ID', 'display_name' (or 'name'), 'include', 'user_login'
     113     *                                             (or 'login'), 'user_nicename' (or 'nicename'), 'user_email'
     114     *                                             (or 'email'), 'user_url' (or 'url'), 'user_registered'
     115     *                                             or 'registered'), 'post_count', 'meta_value', 'meta_value_num',
     116     *                                             the value of `$meta_key`, or an array key of `$meta_query`. To use
    116117     *                                             'meta_value' or 'meta_value_num', `$meta_key` must be also be
    117118     *                                             defined. Default 'user_login'.
Note: See TracChangeset for help on using the changeset viewer.