Changeset 35135

Timestamp:

10/13/2015 03:15:30 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add a changelog entry mentioning that the number argument now supports -1 (all).

Also fixes the argument description.

-1 support was added in [35114].

See #28631.

File:

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

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

@@ -129 +129 @@
      *              for `$orderby` parameter.
      * @since 4.3.0 Added 'has_published_posts' parameter.
-     * @since 4.4.0 Added 'paged', 'role__in', and 'role__not_in' parameters. 'role' parameter was updated to
-     *              permit an array or comma-separated list of values.
+     * @since 4.4.0 Added 'paged', 'role__in', and 'role__not_in' parameters. The 'role' parameter was updated to
+     *              permit an array or comma-separated list of values. The 'number' parameter was updated to support
+     *              querying for all users with using -1.
+     *
      * @access public
      *
@@ -176 +178 @@
      *                                             conjunction with pagination. Default 0.
      *     @type int          $number              Number of users to limit the query for. Can be used in
-     *                                             conjunction with pagination. Value -1 (all) is not supported.
+     *                                             conjunction with pagination. Value -1 (all) is supported, but
+     *                                             should be used with caution on larger sites.
      *                                             Default empty (all users).
      *     @type int          $paged               When used with number, defines the page of results to return.
@@ -420 +423 @@
 
         // limit
-        if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
+        if ( isset( $qv['number'] ) && $qv['number'] ) {
             if ( $qv['offset'] ) {
                 $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);