How to use pre_get_users action in WordPress

pre_get_users action

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

To use the pre_get_users 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_get_users_event which takes 1 parameter and we registered it using add_action. The first parameter pre_get_users is the name of the hook, the second parameter execute_on_pre_get_users_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 to the registered function.

Sometime, you have to remove a registered hook, so you can use remove_action to remove the pre_get_users 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 Examples

Example 1: Basic Usage

Below is an example of how you can use this hook.

    function weplugins_execute_on_pre_get_users_event($query){
       // You can write code here to be executed when this action occurs in WordPress. 
       // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action("pre_get_users", "weplugins_execute_on_pre_get_users_event", 10, 1);
    

Example 2: Modifying User Query

This example demonstrates how to modify the user query to exclude administrators.

    function weplugins_modify_user_query($query) {
        if(!is_admin()) {
            $query->set('role__not_in', ['Administrator']);
        }
    }
    add_action('pre_get_users', 'weplugins_modify_user_query', 10, 1);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_action("pre_get_users", "weplugins_execute_on_pre_get_users_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.