Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use ms_user_list_site_actions filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 28, 2022
5 minutes read

ms_user_list_site_actions filter

Filters the action links displayed next to the sites a user belongs to in the Network Admin Users list table.

To use ms_user_list_site_actions 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_ms_user_list_site_actions_defaults which takes 2 parameters and we registered using add_filter. The first parameter ms_user_list_site_actions is the name of the hook, The second parameter modify_ms_user_list_site_actions_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 ms_user_list_site_actions filter.

Parameters

    Below are the 2 parameters required to use this hook.

  • $actions: (string[]) An array of action links to be displayed. Default ‘Edit’, ‘View’.
  • $userblog_id: (int) The site ID.

Live Example

apply_filters( 'ms_user_list_site_actions', string[] $actions, int $userblog_id )

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

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

Example 1

Adding a custom action link to the user’s site list.

    function weplugins_add_custom_action_link($actions, $userblog_id) {
        $actions['custom_action'] = '<a href="#">Custom Action</a>';
        return $actions;
    }
    add_filter('ms_user_list_site_actions', 'weplugins_add_custom_action_link', 10, 2);
    

Example 2

Conditionally modifying action links based on site ID.

    function weplugins_conditional_action_links($actions, $userblog_id) {
        if ($userblog_id == 1) {
            $actions['special_action'] = '<a href="#">Special Action for Site 1</a>';
        }
        return $actions;
    }
    add_filter('ms_user_list_site_actions', 'weplugins_conditional_action_links', 10, 2);
    

Example 3

Removing the default ‘Edit’ action link.

    function weplugins_remove_edit_action($actions, $userblog_id) {
        unset($actions['edit']);
        return $actions;
    }
    add_filter('ms_user_list_site_actions', 'weplugins_remove_edit_action', 10, 2);
    

To remove a hook callback, use the example below.

    remove_filter( "ms_user_list_site_actions", "weplugins_modify_ms_user_list_site_actions_defaults", 10, 2 );
    

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

Access Premium WordPress Plugins

If you need any customization, feel free to Contact Us.

Sandeep Kumar Mishra

Sandeep Kumar Mishra

Sandeep Kumar Mishra writes about WordPress and Artificial Intelligence, offering tips and guides to help you master your website and stay updated with the latest tech trends.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.