From 5e37130fcda3171290719771e349a5ed898bbc67 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Tue, 13 Oct 2015 15:15:30 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@35135 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-user-query.php | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/class-wp-user-query.php b/src/wp-includes/class-wp-user-query.php index a6ea048e05..59d0c99411 100644 --- a/src/wp-includes/class-wp-user-query.php +++ b/src/wp-includes/class-wp-user-query.php @@ -128,8 +128,10 @@ class WP_User_Query { * @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. - * @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 * * @global wpdb $wpdb @@ -175,7 +177,8 @@ class WP_User_Query { * @type int $offset Number of users to offset in retrieved results. Can be used in * 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. * Default 1. @@ -419,7 +422,7 @@ class WP_User_Query { $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array ); // 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']); } else {