How to use manage_users_custom_column filter in WordPress

manage_users_custom_column filter

Filters the display output of custom columns in the Users list table.

To use the manage_users_custom_column filter, first, you have to register it using add_filter. You can write this code into the 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 weplugins_modify_manage_users_custom_column_defaults which takes 3 parameters and we register it using add_filter. The first parameter manage_users_custom_column is the name of the hook, The second parameter weplugins_modify_manage_users_custom_column_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 manage_users_custom_column filter.

Parameters

Below are the 3 parameters required to use this hook.

• $output: (string) Custom column output. Default empty.
• $column_name: (string) Column name.
• $user_id: (int) ID of the currently-listed user.

Live Example

Example 1: Adds Custom Column To Users List Table

Below is an example of how you can add a custom column to the Users list table.

    // Adds Custom Column To Users List Table
    function weplugins_add_user_id_column($columns) {
        $columns['user_id'] = 'User ID';
        return $columns;
    }
    add_filter('manage_users_columns', 'weplugins_add_user_id_column');
    
    // Adds Content To The Custom Added Column
    function weplugins_show_user_id_column_content($value, $column_name, $user_id) {
        $user = get_userdata($user_id);
        if ('user_id' == $column_name) {
            return $user->ID;
        }
        return $value;
    }
    add_filter('manage_users_custom_column', 'weplugins_show_user_id_column_content', 10, 3);
    

Example 2: Modify Manage Users Custom Column Defaults

Below is an example of how you can use this hook to modify the custom column’s default output.

    function weplugins_modify_manage_users_custom_column_defaults($output, $column_name, $user_id) {
        // Update the $output variable according to your website requirements and return this variable. You can modify the $output variable conditionally too if you want.
        return $output;
    }
    // Add the filter
    add_filter("manage_users_custom_column", "weplugins_modify_manage_users_custom_column_defaults", 10, 3);
    

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("manage_users_custom_column", "weplugins_modify_manage_users_custom_column_defaults", 10, 3);
    

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.