How to use found_users_query filter in WordPress

found_users_query filter

Filters SELECT FOUND_ROWS() query for the current WP_User_Query instance.

To use the found_users_query filter, first you have to register it using add_filter. 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 modify_found_users_query_defaults which takes 2 parameters and we registered using add_filter. The first parameter found_users_query is the name of the hook, the second parameter modify_found_users_query_defaults 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_filter to remove the found_users_query filter.

Parameters

Below are the 2 parameters required to use this hook.

• $sql : (string) The SELECT FOUND_ROWS() query for the current WP_User_Query.
• $query : (WP_User_Query) The current WP_User_Query instance.

Live Example

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

Example 1: Modifying the SQL Query

This example shows how to modify the SQL query used by WP_User_Query.

    function weplugins_modify_found_users_query_defaults($sql, $query) { 
        // Update the $sql variable according to your website requirements and return this variable.
        // You can modify the $sql variable conditionally too if you want.
        return $sql; 
    }
    // Add the filter
    add_filter("found_users_query", "weplugins_modify_found_users_query_defaults", 10, 2);
    

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter("found_users_query", "weplugins_modify_found_users_query_defaults", 10, 2);
    

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

Example 3: Conditional Modification

This example demonstrates how you can conditionally modify the SQL query based on specific criteria.

    function weplugins_modify_found_users_query_conditionally($sql, $query) { 
        // Apply custom logic here
        if ( isset($query->query_vars['role']) && $query->query_vars['role'] == 'editor' ) {
            // Modify $sql for editors
        }
        return $sql; 
    }
    // Add the filter
    add_filter("found_users_query", "weplugins_modify_found_users_query_conditionally", 10, 2);
    

Contact Us

If you need any customization or have trouble using this hook, please contact us. We’d be happy to assist you.