pre_get_users

Fires before the WP_User_Query has been parsed.

Description

do_action( 'pre_get_users', (WP_User_Query) $instance ); 

The passed WP_User_Query object contains the query variables, not yet passed into SQL.

Parameters (1)

0. $instance (WP_User_Query)
The current WP_User_Query instance, passed by reference.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'pre_get_users', $instance ); 
The following example is for adding a hook callback.
  1. // define the pre_get_users callback 
  2. function action_pre_get_users( $instance ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'pre_get_users', 'action_pre_get_users', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'pre_get_users', 'action_pre_get_users', 10, 1 ); 

Defined (1)

The action is defined in the following location(s).

/wp-includes/class-wp-user-query.php  
  1. do_action( 'pre_get_users', $this );