enmi-conf.org: comparison wp/wp-includes/class-wp-user-query.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 		$defaults = array(
 			'blog_id'             => get_current_blog_id(),
 			'role'                => '',
 			'role__in'            => array(),
 			'role__not_in'        => array(),
+			'capability'          => '',
+			'capability__in'      => array(),
+			'capability__not_in'  => array(),
 			'meta_key'            => '',
 			'meta_value'          => '',
 			'meta_compare'        => '',
 			'include'             => array(),
 			'exclude'             => array(),
 		return wp_parse_args( $args, $defaults );
 	}
 	/**
-	 * Prepare the query variables.
+	 * Prepares 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.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.
 	 * @since 4.7.0 Added 'nicename', 'nicename__in', 'nicename__not_in', 'login', 'login__in',
 	 *              and 'login__not_in' parameters.
+	 * @since 5.1.0 Introduced the 'meta_compare_key' parameter.
+	 * @since 5.3.0 Introduced the 'meta_type_key' parameter.
+	 * @since 5.9.0 Added 'capability', 'capability__in', and 'capability__not_in' parameters.
 	 *
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 * @global int  $blog_id
 	 *
 	 * @param string|array $query {
 	 *     Optional. Array or string of Query parameters.
 	 *
-	 *     @type int          $blog_id             The site ID. Default is the current site.
+	 *     @type int             $blog_id             The site ID. Default is the current site.
-	 *     @type string|array $role                An array or a comma-separated list of role names that users must match
+	 *     @type string|string[] $role                An array or a comma-separated list of role names that users must match
-	 *                                             to be included in results. Note that this is an inclusive list: users
+	 *                                                to be included in results. Note that this is an inclusive list: users
-	 *                                             must match *each* role. Default empty.
+	 *                                                must match *each* role. Default empty.
-	 *     @type string[]     $role__in            An array of role names. Matched users must have at least one of these
+	 *     @type string[]        $role__in            An array of role names. Matched users must have at least one of these
-	 *                                             roles. Default empty array.
+	 *                                                roles. Default empty array.
-	 *     @type string[]     $role__not_in        An array of role names to exclude. Users matching one or more of these
+	 *     @type string[]        $role__not_in        An array of role names to exclude. Users matching one or more of these
-	 *                                             roles will not be included in results. Default empty array.
+	 *                                                roles will not be included in results. Default empty array.
-	 *     @type string       $meta_key            User meta key. Default empty.
+	 *     @type string|string[] $meta_key            Meta key or keys to filter by.
-	 *     @type string       $meta_value          User meta value. Default empty.
+	 *     @type string|string[] $meta_value          Meta value or values to filter by.
-	 *     @type string       $meta_compare        Comparison operator to test the `$meta_value`. Accepts '=', '!=',
+	 *     @type string          $meta_compare        MySQL operator used for comparing the meta value.
-	 *                                             '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN',
+	 *                                                See WP_Meta_Query::__construct for accepted values and default value.
-	 *                                             'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS', 'REGEXP',
+	 *     @type string          $meta_compare_key    MySQL operator used for comparing the meta key.
-	 *                                             'NOT REGEXP', or 'RLIKE'. Default '='.
+	 *                                                See WP_Meta_Query::__construct for accepted values and default value.
-	 *     @type int[]        $include             An array of user IDs to include. Default empty array.
+	 *     @type string          $meta_type           MySQL data type that the meta_value column will be CAST to for comparisons.
-	 *     @type int[]        $exclude             An array of user IDs to exclude. Default empty array.
+	 *                                                See WP_Meta_Query::__construct for accepted values and default value.
-	 *     @type string       $search              Search keyword. Searches for possible string matches on columns.
+	 *     @type string          $meta_type_key       MySQL data type that the meta_key column will be CAST to for comparisons.
-	 *                                             When `$search_columns` is left empty, it tries to determine which
+	 *                                                See WP_Meta_Query::__construct for accepted values and default value.
-	 *                                             column to search in based on search string. Default empty.
+	 *     @type array           $meta_query          An associative array of WP_Meta_Query arguments.
-	 *     @type string[]     $search_columns      Array of column names to be searched. Accepts 'ID', 'user_login',
+	 *                                                See WP_Meta_Query::__construct for accepted values.
-	 *                                             'user_email', 'user_url', 'user_nicename', 'display_name'.
+	 *     @type string|string[] $capability          An array or a comma-separated list of capability names that users must match
-	 *                                             Default empty array.
+	 *                                                to be included in results. Note that this is an inclusive list: users
-	 *     @type string|array $orderby             Field(s) to sort the retrieved users by. May be a single value,
+	 *                                                must match *each* capability.
-	 *                                             an array of values, or a multi-dimensional array with fields as
+	 *                                                Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}.
-	 *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
+	 *                                                Default empty.
-	 *                                             'ID', 'display_name' (or 'name'), 'include', 'user_login'
+	 *     @type string[]        $capability__in      An array of capability names. Matched users must have at least one of these
-	 *                                             (or 'login'), 'login__in', 'user_nicename' (or 'nicename'),
+	 *                                                capabilities.
-	 *                                             'nicename__in', 'user_email (or 'email'), 'user_url' (or 'url'),
+	 *                                                Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}.
-	 *                                             'user_registered' (or 'registered'), 'post_count', 'meta_value',
+	 *                                                Default empty array.
-	 *                                             'meta_value_num', the value of `$meta_key`, or an array key of
+	 *     @type string[]        $capability__not_in  An array of capability names to exclude. Users matching one or more of these
-	 *                                             `$meta_query`. To use 'meta_value' or 'meta_value_num', `$meta_key`
+	 *                                                capabilities will not be included in results.
-	 *                                             must be also be defined. Default 'user_login'.
+	 *                                                Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}.
-	 *     @type string       $order               Designates ascending or descending order of users. Order values
+	 *                                                Default empty array.
-	 *                                             passed as part of an `$orderby` array take precedence over this
+	 *     @type int[]           $include             An array of user IDs to include. Default empty array.
-	 *                                             parameter. Accepts 'ASC', 'DESC'. Default 'ASC'.
+	 *     @type int[]           $exclude             An array of user IDs to exclude. Default empty array.
-	 *     @type int          $offset              Number of users to offset in retrieved results. Can be used in
+	 *     @type string          $search              Search keyword. Searches for possible string matches on columns.
-	 *                                             conjunction with pagination. Default 0.
+	 *                                                When `$search_columns` is left empty, it tries to determine which
-	 *     @type int          $number              Number of users to limit the query for. Can be used in
+	 *                                                column to search in based on search string. Default empty.
-	 *                                             conjunction with pagination. Value -1 (all) is supported, but
+	 *     @type string[]        $search_columns      Array of column names to be searched. Accepts 'ID', 'user_login',
-	 *                                             should be used with caution on larger sites.
+	 *                                                'user_email', 'user_url', 'user_nicename', 'display_name'.
-	 *                                             Default -1 (all users).
+	 *                                                Default empty array.
-	 *     @type int          $paged               When used with number, defines the page of results to return.
+	 *     @type string|array    $orderby             Field(s) to sort the retrieved users by. May be a single value,
-	 *                                             Default 1.
+	 *                                                an array of values, or a multi-dimensional array with fields as
-	 *     @type bool         $count_total         Whether to count the total number of users found. If pagination
+	 *                                                keys and orders ('ASC' or 'DESC') as values. Accepted values are:
-	 *                                             is not needed, setting this to false can improve performance.
+	 *                                                - 'ID'
-	 *                                             Default true.
+	 *                                                - 'display_name' (or 'name')
-	 *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
+	 *                                                - 'include'
-	 *                                             of fields. Accepts 'ID', 'display_name', 'user_login',
+	 *                                                - 'user_login' (or 'login')
-	 *                                             'user_nicename', 'user_email', 'user_url', 'user_registered'.
+	 *                                                - 'login__in'
-	 *                                             Use 'all' for all fields and 'all_with_meta' to include
+	 *                                                - 'user_nicename' (or 'nicename'),
-	 *                                             meta fields. Default 'all'.
+	 *                                                - 'nicename__in'
-	 *     @type string       $who                 Type of users to query. Accepts 'authors'.
+	 *                                                - 'user_email (or 'email')
-	 *                                             Default empty (all users).
+	 *                                                - 'user_url' (or 'url'),
-	 *     @type bool|array   $has_published_posts Pass an array of post types to filter results to users who have
+	 *                                                - 'user_registered' (or 'registered')
-	 *                                             published posts in those post types. `true` is an alias for all
+	 *                                                - 'post_count'
-	 *                                             public post types.
+	 *                                                - 'meta_value',
-	 *     @type string       $nicename            The user nicename. Default empty.
+	 *                                                - 'meta_value_num'
-	 *     @type string[]     $nicename__in        An array of nicenames to include. Users matching one of these
+	 *                                                - The value of `$meta_key`
-	 *                                             nicenames will be included in results. Default empty array.
+	 *                                                - An array key of `$meta_query`
-	 *     @type string[]     $nicename__not_in    An array of nicenames to exclude. Users matching one of these
+	 *                                                To use 'meta_value' or 'meta_value_num', `$meta_key`
-	 *                                             nicenames will not be included in results. Default empty array.
+	 *                                                must be also be defined. Default 'user_login'.
-	 *     @type string       $login               The user login. Default empty.
+	 *     @type string          $order               Designates ascending or descending order of users. Order values
-	 *     @type string[]     $login__in           An array of logins to include. Users matching one of these
+	 *                                                passed as part of an `$orderby` array take precedence over this
-	 *                                             logins will be included in results. Default empty array.
+	 *                                                parameter. Accepts 'ASC', 'DESC'. Default 'ASC'.
-	 *     @type string[]     $login__not_in       An array of logins to exclude. Users matching one of these
+	 *     @type int             $offset              Number of users to offset in retrieved results. Can be used in
-	 *                                             logins will not be included in results. Default empty array.
+	 *                                                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 supported, but
+	 *                                                should be used with caution on larger sites.
+	 *                                                Default -1 (all users).
+	 *     @type int             $paged               When used with number, defines the page of results to return.
+	 *                                                Default 1.
+	 *     @type bool            $count_total         Whether to count the total number of users found. If pagination
+	 *                                                is not needed, setting this to false can improve performance.
+	 *                                                Default true.
+	 *     @type string|string[] $fields              Which fields to return. Single or all fields (string), or array
+	 *                                                of fields. Accepts:
+	 *                                                - 'ID'
+	 *                                                - 'display_name'
+	 *                                                - 'user_login'
+	 *                                                - 'user_nicename'
+	 *                                                - 'user_email'
+	 *                                                - 'user_url'
+	 *                                                - 'user_registered'
+	 *                                                - 'user_pass'
+	 *                                                - 'user_activation_key'
+	 *                                                - 'user_status'
+	 *                                                - 'spam' (only available on multisite installs)
+	 *                                                - 'deleted' (only available on multisite installs)
+	 *                                                - 'all' for all fields
+	 *                                                - 'all_with_meta' to include meta fields.
+	 *                                                Default 'all'.
+	 *     @type string          $who                 Type of users to query. Accepts 'authors'.
+	 *                                                Default empty (all users).
+	 *     @type bool|string[]   $has_published_posts Pass an array of post types to filter results to users who have
+	 *                                                published posts in those post types. `true` is an alias for all
+	 *                                                public post types.
+	 *     @type string          $nicename            The user nicename. Default empty.
+	 *     @type string[]        $nicename__in        An array of nicenames to include. Users matching one of these
+	 *                                                nicenames will be included in results. Default empty array.
+	 *     @type string[]        $nicename__not_in    An array of nicenames to exclude. Users matching one of these
+	 *                                                nicenames will not be included in results. Default empty array.
+	 *     @type string          $login               The user login. Default empty.
+	 *     @type string[]        $login__in           An array of logins to include. Users matching one of these
+	 *                                                logins will be included in results. Default empty array.
+	 *     @type string[]        $login__not_in       An array of logins to exclude. Users matching one of these
+	 *                                                logins will not be included in results. Default empty array.
 	 * }
 	 */
 	public function prepare_query( $query = array() ) {
 		global $wpdb;
 		// Ensure that query vars are filled after 'pre_get_users'.
 		$qv =& $this->query_vars;
 		$qv = $this->fill_query_vars( $qv );
+		$allowed_fields = array(
+			'id',
+			'user_login',
+			'user_pass',
+			'user_nicename',
+			'user_email',
+			'user_url',
+			'user_registered',
+			'user_activation_key',
+			'user_status',
+			'display_name',
+		);
+		if ( is_multisite() ) {
+			$allowed_fields[] = 'spam';
+			$allowed_fields[] = 'deleted';
+		}
 		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
+			$qv['fields'] = array_map( 'strtolower', $qv['fields'] );
+			$qv['fields'] = array_intersect( array_unique( $qv['fields'] ), $allowed_fields );
+			if ( empty( $qv['fields'] ) ) {
+				$qv['fields'] = array( 'id' );
+			}
 			$this->query_fields = array();
 			foreach ( $qv['fields'] as $field ) {
-				$field                = 'ID' === $field ? 'ID' : sanitize_key( $field );
+				$field                = 'id' === $field ? 'ID' : sanitize_key( $field );
 				$this->query_fields[] = "$wpdb->users.$field";
 			}
 			$this->query_fields = implode( ',', $this->query_fields );
 		} elseif ( 'all' === $qv['fields'] ) {
 			$this->query_fields = "$wpdb->users.*";
+		} elseif ( ! in_array( $qv['fields'], $allowed_fields, true ) ) {
+			$this->query_fields = "$wpdb->users.ID";
 		} else {
-			$this->query_fields = "$wpdb->users.ID";
+			$field              = 'id' === strtolower( $qv['fields'] ) ? 'ID' : sanitize_key( $qv['fields'] );
+			$this->query_fields = "$wpdb->users.$field";
 		}
 		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
 			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 		}
 		// Meta query.
 		$this->meta_query = new WP_Meta_Query();
 		$this->meta_query->parse_query_vars( $qv );
 		if ( isset( $qv['who'] ) && 'authors' === $qv['who'] && $blog_id ) {
+			_deprecated_argument(
+				'WP_User_Query',
+				'5.9.0',
+				sprintf(
+					/* translators: 1: who, 2: capability */
+					__( '%1$s is deprecated. Use %2$s instead.' ),
+					'<code>who</code>',
+					'<code>capability</code>'
+				)
+			);
 			$who_query = array(
 				'key'     => $wpdb->get_blog_prefix( $blog_id ) . 'user_level',
 				'value'   => 0,
 				'compare' => '!=',
 			);
 			}
 			$this->meta_query->parse_query_vars( $this->meta_query->queries );
 		}
+		// Roles.
 		$roles = array();
 		if ( isset( $qv['role'] ) ) {
 			if ( is_array( $qv['role'] ) ) {
 				$roles = $qv['role'];
 			} elseif ( is_string( $qv['role'] ) && ! empty( $qv['role'] ) ) {
 		}
 		$role__not_in = array();
 		if ( isset( $qv['role__not_in'] ) ) {
 			$role__not_in = (array) $qv['role__not_in'];
+		}
+		// Capabilities.
+		$available_roles = array();
+		if ( ! empty( $qv['capability'] ) || ! empty( $qv['capability__in'] ) || ! empty( $qv['capability__not_in'] ) ) {
+			global $wp_roles;
+			$wp_roles->for_site( $blog_id );
+			$available_roles = $wp_roles->roles;
+		}
+		$capabilities = array();
+		if ( ! empty( $qv['capability'] ) ) {
+			if ( is_array( $qv['capability'] ) ) {
+				$capabilities = $qv['capability'];
+			} elseif ( is_string( $qv['capability'] ) ) {
+				$capabilities = array_map( 'trim', explode( ',', $qv['capability'] ) );
+			}
+		}
+		$capability__in = array();
+		if ( ! empty( $qv['capability__in'] ) ) {
+			$capability__in = (array) $qv['capability__in'];
+		}
+		$capability__not_in = array();
+		if ( ! empty( $qv['capability__not_in'] ) ) {
+			$capability__not_in = (array) $qv['capability__not_in'];
+		}
+		// Keep track of all capabilities and the roles they're added on.
+		$caps_with_roles = array();
+		foreach ( $available_roles as $role => $role_data ) {
+			$role_caps = array_keys( array_filter( $role_data['capabilities'] ) );
+			foreach ( $capabilities as $cap ) {
+				if ( in_array( $cap, $role_caps, true ) ) {
+					$caps_with_roles[ $cap ][] = $role;
+					break;
+				}
+			}
+			foreach ( $capability__in as $cap ) {
+				if ( in_array( $cap, $role_caps, true ) ) {
+					$role__in[] = $role;
+					break;
+				}
+			}
+			foreach ( $capability__not_in as $cap ) {
+				if ( in_array( $cap, $role_caps, true ) ) {
+					$role__not_in[] = $role;
+					break;
+				}
+			}
+		}
+		$role__in     = array_merge( $role__in, $capability__in );
+		$role__not_in = array_merge( $role__not_in, $capability__not_in );
+		$roles        = array_unique( $roles );
+		$role__in     = array_unique( $role__in );
+		$role__not_in = array_unique( $role__not_in );
+		// Support querying by capabilities added directly to users.
+		if ( $blog_id && ! empty( $capabilities ) ) {
+			$capabilities_clauses = array( 'relation' => 'AND' );
+			foreach ( $capabilities as $cap ) {
+				$clause = array( 'relation' => 'OR' );
+				$clause[] = array(
+					'key'     => $wpdb->get_blog_prefix( $blog_id ) . 'capabilities',
+					'value'   => '"' . $cap . '"',
+					'compare' => 'LIKE',
+				);
+				if ( ! empty( $caps_with_roles[ $cap ] ) ) {
+					foreach ( $caps_with_roles[ $cap ] as $role ) {
+						$clause[] = array(
+							'key'     => $wpdb->get_blog_prefix( $blog_id ) . 'capabilities',
+							'value'   => '"' . $role . '"',
+							'compare' => 'LIKE',
+						);
+					}
+				}
+				$capabilities_clauses[] = $clause;
+			}
+			$role_queries[] = $capabilities_clauses;
+			if ( empty( $this->meta_query->queries ) ) {
+				$this->meta_query->queries[] = $capabilities_clauses;
+			} else {
+				// Append the cap query to the original queries and reparse the query.
+				$this->meta_query->queries = array(
+					'relation' => 'AND',
+					array( $this->meta_query->queries, array( $capabilities_clauses ) ),
+				);
+			}
+			$this->meta_query->parse_query_vars( $this->meta_query->queries );
 		}
 		if ( $blog_id && ( ! empty( $roles ) || ! empty( $role__in ) || ! empty( $role__not_in ) || is_multisite() ) ) {
 			$role_queries = array();
 		 */
 		do_action_ref_array( 'pre_user_query', array( &$this ) );
 	}
 	/**
-	 * Execute the query, with the current variables.
+	 * Executes the query, with the current variables.
 	 *
 	 * @since 3.1.0
 	 *
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 */
 		 * @param WP_User_Query $query   The WP_User_Query instance (passed by reference).
 		 */
 		$this->results = apply_filters_ref_array( 'users_pre_query', array( null, &$this ) );
 		if ( null === $this->results ) {
-			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+			$this->request = "
+				SELECT {$this->query_fields}
+				{$this->query_from}
+				{$this->query_where}
+				{$this->query_orderby}
+				{$this->query_limit}
+			";
 			if ( is_array( $qv['fields'] ) || 'all' === $qv['fields'] ) {
 				$this->results = $wpdb->get_results( $this->request );
 			} else {
 				$this->results = $wpdb->get_col( $this->request );
 		}
 		if ( ! $this->results ) {
 			return;
 		}
+		if (
-		if ( 'all_with_meta' === $qv['fields'] ) {
+			is_array( $qv['fields'] ) &&
+			isset( $this->results[0]->ID )
+		) {
+			foreach ( $this->results as $result ) {
+				$result->id = $result->ID;
+			}
+		} elseif ( 'all_with_meta' === $qv['fields'] ) {
 			cache_users( $this->results );
 			$r = array();
 			foreach ( $this->results as $userid ) {
 				$r[ $userid ] = new WP_User( $userid, '', $qv['blog_id'] );
 			}
 		}
 	}
 	/**
-	 * Retrieve query variable.
+	 * Retrieves query variable.
 	 *
 	 * @since 3.5.0
 	 *
 	 * @param string $query_var Query variable key.
 	 * @return mixed
 		return null;
 	}
 	/**
-	 * Set query variable.
+	 * Sets query variable.
 	 *
 	 * @since 3.5.0
 	 *
 	 * @param string $query_var Query variable key.
 	 * @param mixed  $value     Query variable value.
 	public function set( $query_var, $value ) {
 		$this->query_vars[ $query_var ] = $value;
 	}
 	/**
-	 * Used internally to generate an SQL string for searching across multiple columns
+	 * Used internally to generate an SQL string for searching across multiple columns.
 	 *
 	 * @since 3.1.0
 	 *
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 *
-	 * @param string $string
+	 * @param string   $search  Search string.
-	 * @param array  $cols
+	 * @param string[] $columns Array of columns to search.
-	 * @param bool   $wild   Whether to allow wildcard searches. Default is false for Network Admin, true for single site.
+	 * @param bool     $wild    Whether to allow wildcard searches. Default is false for Network Admin, true for single site.
-	 *                       Single site allows leading and trailing wildcards, Network Admin only trailing.
+	 *                          Single site allows leading and trailing wildcards, Network Admin only trailing.
 	 * @return string
 	 */
-	protected function get_search_sql( $string, $cols, $wild = false ) {
+	protected function get_search_sql( $search, $columns, $wild = false ) {
 		global $wpdb;
 		$searches      = array();
 		$leading_wild  = ( 'leading' === $wild || 'both' === $wild ) ? '%' : '';
 		$trailing_wild = ( 'trailing' === $wild || 'both' === $wild ) ? '%' : '';
-		$like          = $leading_wild . $wpdb->esc_like( $string ) . $trailing_wild;
+		$like          = $leading_wild . $wpdb->esc_like( $search ) . $trailing_wild;
-		foreach ( $cols as $col ) {
+		foreach ( $columns as $column ) {
-			if ( 'ID' === $col ) {
+			if ( 'ID' === $column ) {
-				$searches[] = $wpdb->prepare( "$col = %s", $string );
+				$searches[] = $wpdb->prepare( "$column = %s", $search );
 			} else {
-				$searches[] = $wpdb->prepare( "$col LIKE %s", $like );
+				$searches[] = $wpdb->prepare( "$column LIKE %s", $like );
 			}
 		}
 		return ' AND (' . implode( ' OR ', $searches ) . ')';
 	}
 	/**
-	 * Return the list of users.
+	 * Returns the list of users.
 	 *
 	 * @since 3.1.0
 	 *
 	 * @return array Array of results.
 	 */
 	public function get_results() {
 		return $this->results;
 	}
 	/**
-	 * Return the total number of users for the current query.
+	 * Returns the total number of users for the current query.
 	 *
 	 * @since 3.1.0
 	 *
 	 * @return int Number of total users.
 	 */
 	public function get_total() {
 		return $this->total_users;
 	}
 	/**
-	 * Parse and sanitize 'orderby' keys passed to the user query.
+	 * Parses and sanitizes 'orderby' keys passed to the user query.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 *
 		return $_orderby;
 	}
 	/**
-	 * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+	 * Parses an 'order' query variable and casts it to ASC or DESC as necessary.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param string $order The 'order' query variable.
 	 * @return string The sanitized 'order' query variable.
 			return 'DESC';
 		}
 	}
 	/**
-	 * Make private properties readable for backward compatibility.
+	 * Makes private properties readable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
 	 * @param string $name Property to get.
 	 * @return mixed Property.
 			return $this->$name;
 		}
 	}
 	/**
-	 * Make private properties settable for backward compatibility.
+	 * Makes private properties settable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
 	 * @param string $name  Property to check if set.
 	 * @param mixed  $value Property value.
 			return $this->$name = $value;
 		}
 	}
 	/**
-	 * Make private properties checkable for backward compatibility.
+	 * Makes private properties checkable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
 	 * @param string $name Property to check if set.
 	 * @return bool Whether the property is set.
 			return isset( $this->$name );
 		}
 	}
 	/**
-	 * Make private properties un-settable for backward compatibility.
+	 * Makes private properties un-settable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
 	 * @param string $name Property to unset.
 	 */
 			unset( $this->$name );
 		}
 	}
 	/**
-	 * Make private/protected methods readable for backward compatibility.
+	 * Makes private/protected methods readable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
 	 * @param string $name      Method to call.
 	 * @param array  $arguments Arguments to pass when calling.

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6