pre_user_query

Fires after the WP_User_Query has been parsed, and before the query is executed.

Description

do_action( 'pre_user_query', (array) $array ); 

The passed WP_User_Query object contains SQL parts formed from parsing the given query.

Parameters (1)

0. $array (array) => array( &$this )
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_user_query', $array ); 
The following example is for adding a hook callback.
  1. // define the pre_user_query callback 
  2. function action_pre_user_query( $array ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'pre_user_query', 'action_pre_user_query', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'pre_user_query', 'action_pre_user_query', 10, 1 ); 

Defined (1)

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

/wp-includes/class-wp-user-query.php  
  1. do_action_ref_array( 'pre_user_query', array( &$this ) );