Add hook to filter users

Hi,

I'd like to second this request. hook_user_filters would be very useful when adding lots of data to the user object. A hook_user_filters implementation could return an associative array of filters in the same form the user_filters function currently uses:

 function mymodule_user_filters(){
    return array(
      'filter_name' => array(
         'title' => t('title'),
         'join' => 'join clause',
         'where' => 'where clause',
         'options' => array(),
      ),
    );
}

Thanks!

Can this be done in Drupal 6.x , i see no other way than hack the core :(

This would be very convenient for the cas module which could then allow to filter by users with associated cas entries in the {authmap} table.

I've submitted some 'minimally intrusive' code. Basic changes to 7.x-dev:

1. Creation of hook_user_filters(). Return value is similar to what user_filters() current returns, with the addition of 'callback' and 'callback arguments' to set the function used to do implement the actual filtering.
2. Rename user_filters() to user_user_filters() [so that it implements the hook]. Add 'callback' of 'user_build_filter_query'.
3. Have user_build_filter_query() expect the $filters passed as an argument instead of in $_SESSION['user_overview_filter']).
4. Replace every instance of $filters = user_filters() with $filters = module_invoke_all('user_filters');
5. Document the API addition in user.api.php

Given the required change to user_build_filter_query(), it'd be hard to argue that this should go in 7.x.... but with some slight modifications, it could be implemented in a way that didn't break any of the existing functionality.

+++ modules/user/user.api.phpundefined
@@ -185,6 +185,40 @@ function hook_user_operations() {
+ * The module must also implement hook_user_filter_query_alter() to do implement
+ * the actual filtering.

These lines were based upon an older method which as superseded by the 'callback' approach.

Powered by Dreditor.

Major revisions here. I'll update the issue status when I get a chance.

Last patch failed because I bungled up the structure of $applied_filters. This one is manually tested to work.

Patch no longer applies.

error: patch failed: core/modules/user/user.admin.inc:33
error: core/modules/user/user.admin.inc: patch does not apply
error: patch failed: core/modules/user/user.api.php:183
error: core/modules/user/user.api.php: patch does not apply
error: patch failed: core/modules/user/user.module:3293
error: core/modules/user/user.module: patch does not apply

That said though, is this issue still relevant with Views in core now?

We use Views nowdays..

Marked as outdated