do_action_ref_array( 'pre_get_users', WP_User_Query $query )
- Since
- 4.0.0
Fires before the WP_User_Query has been parsed.
Description
The passed WP_User_Query object contains the query variables, not yet passed into SQL.
Compatibility
- WordPress
- since 4.0.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$queryWP_User_Query- Current instance of WP_User_Query (passed by reference).
Where this hook fires · 1
wp-includes/class-wp-user-query.php:283WP_User_Query::prepare_query()
Source code
* not yet passed into SQL. * * @since 4.0.0 * * @param WP_User_Query $query Current instance of WP_User_Query (passed by reference). */ do_action_ref_array( 'pre_get_users', array( &$this ) ); // Ensure that query vars are filled after 'pre_get_users'. $qv =& $this->query_vars; $qv = $this->fill_query_vars( $qv ); $allowed_fields = array(Changelog
Introduced in 4.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, 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.