How to use pre_user_query action in WordPress

pre_user_query action

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

To use the pre_user_query action, first, you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function execute_on_pre_user_query_event which takes 1 parameter and we registered it using add_action. The first parameter pre_user_query is the name of the hook, the second parameter execute_on_pre_user_query_event is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_action to remove pre_user_query action.

Parameters

Below the 1 parameter is required to use this hook.

• $query : (WP_User_Query) Current instance of WP_User_Query (passed by reference).

Live Example 1

Below is an example of how you can use this hook to modify user queries based on specific search terms.

    add_action( 'pre_user_query', function( $uqi ) {
        global $wpdb;
        $search = '';
        if ( isset( $uqi->query_vars['search'] ) )
            $search = trim( $uqi->query_vars['search'] );
        if ( $search ) {
            // Custom SQL modifications can be done here
        }
    });
    

Live Example 2

This example shows a basic implementation where a function ‘execute_on_pre_user_query_event’ is executed when the hook is triggered.

    function weplugins_execute_on_pre_user_query_event($query){
        // Custom functionality here
    }
    // add the action
    add_action( "pre_user_query", "weplugins_execute_on_pre_user_query_event" , 10, 1);
    

Live Example 3

To remove a hook callback, use the example below.

    remove_action( "pre_user_query", "weplugins_execute_on_pre_user_query_event", 10, 1 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.