WP_User_Query

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 5

Every hook that fires from inside WP_User_Query, in the order it appears in the class, grouped by the method that fires it.

Properties · 11

$query_varsarraypublic

Query vars, after parsing

$resultsarrayprivate

List of found user IDs.

$total_usersintprivate

Total number of found users for the current query

$meta_queryWP_Meta_Querypublic

Metadata query container.

$requeststringpublic

The SQL query used to fetch matching users.

$compat_fieldsprivate

$query_fieldspublic

$query_frompublic

$query_wherepublic

$query_orderbypublic

$query_limitpublic

Methods · 17

• __construct()Constructor.
• fill_query_vars()Fills in missing query variables with default values.
• prepare_query()Prepares the query variables.
• query()Executes the query, with the current variables.
• get()Retrieves query variable.
• set()Sets query variable.
• get_search_sql()Used internally to generate an SQL string for searching across multiple columns.
• get_results()Returns the list of users.
• get_total()Returns the total number of users for the current query.
• parse_orderby()Parses and sanitizes 'orderby' keys passed to the user query.
• generate_cache_key()Generate cache key.
• parse_order()Parses an 'order' query variable and casts it to ASC or DESC as necessary.
• __get()Makes private properties readable for backward compatibility.
• __set()Makes private properties settable for backward compatibility.
• __isset()Makes private properties checkable for backward compatibility.
• __unset()Makes private properties un-settable for backward compatibility.
• __call()Makes private/protected methods readable for backward compatibility.

Source code

View on Trac ↗View on GitHub ↗

17#[AllowDynamicProperties]18class WP_User_Query {19 20	/**21	 * Query vars, after parsing22	 *23	 * @since 3.5.024	 * @var array25	 */26	public $query_vars = array();27 28	/**29	 * List of found user IDs.30	 *31	 * @since 3.1.032	 * @var array33	 */34	private $results;35 36	/**37	 * Total number of found users for the current query38	 *39	 * @since 3.1.040	 * @var int41	 */42	private $total_users = 0;43 44	/**45	 * Metadata query container.46	 *47	 * @since 4.2.048	 * @var WP_Meta_Query49	 */50	public $meta_query = false;51 52	/**53	 * The SQL query used to fetch matching users.54	 *55	 * @since 4.4.056	 * @var string57	 */58	public $request;59 60	private $compat_fields = array( 'results', 'total_users' );61 62	// SQL clauses.63	public $query_fields;64	public $query_from;65	public $query_where;66	public $query_orderby;67	public $query_limit;68 69	/**70	 * Constructor.71	 *72	 * @since 3.1.073	 *74	 * @param null|string|array $query Optional. The query variables.75	 *                                 See WP_User_Query::prepare_query() for information on accepted arguments.76	 */77	public function __construct( $query = null ) {78		if ( ! empty( $query ) ) {79			$this->prepare_query( $query );80			$this->query();81		}82	}83 84	/**85	 * Fills in missing query variables with default values.86	 *87	 * @since 4.4.088	 *89	 * @param string|array $args Query vars, as passed to `WP_User_Query`.90	 * @return array Complete query variables with undefined ones filled in with defaults.91	 */92	public static function fill_query_vars( $args ) {93		$defaults = array(94			'blog_id'             => get_current_blog_id(),95			'role'                => '',96			'role__in'            => array(),

Changelog

Introduced in 3.1.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-user-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.