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.

// run the action 
do_action( 'pre_user_query', $array ); 

The following example is for adding a hook callback.

// define the pre_user_query callback 
function action_pre_user_query( $array ) { 
    // make action magic happen here... 
}; 
         
// add the action 
add_action( 'pre_user_query', 'action_pre_user_query', 10, 1 ); 

To remove a hook callback, use the example below.

// remove the action 
remove_action( 'pre_user_query', 'action_pre_user_query', 10, 1 );