How to use get_blogs_of_user filter in WordPress

get_blogs_of_user filter

Filters the list of sites a user belongs to.

To use get_blogs_of_user 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 weplugins_modify_get_blogs_of_user_defaults which takes 3 parameters, and we registered it using add_filter. The first parameter get_blogs_of_user is the name of the hook, the second parameter weplugins_modify_get_blogs_of_user_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 get_blogs_of_user filter.

Parameters

• $sites: (object[]) An array of site objects belonging to the user.
• $user_id: (int) User ID.
• $all: (bool) Whether the returned sites array should contain all sites, including those marked ‘deleted’, ‘archived’, or ‘spam’. Default false.

Live Example

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

Example 1: Basic Usage

This example demonstrates how to modify the list of blogs a user belongs to.

    function weplugins_modify_get_blogs_of_user_defaults($sites, $user_id, $all) { 
        // Update the $sites variable according to your website requirements and return this variable. You can modify the $sites variable conditionally too if you want.
        return $sites; 
    }
    // add the filter
    add_filter("get_blogs_of_user", "weplugins_modify_get_blogs_of_user_defaults", 10, 3);
    

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("get_blogs_of_user", "weplugins_modify_get_blogs_of_user_defaults", 10, 3);
    

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 shows how to conditionally modify the list of blogs.

    function weplugins_modify_get_blogs_of_user_conditionally($sites, $user_id, $all) { 
        if ($user_id == 1) {
            // Modify the $sites array for user ID 1
        }
        return $sites; 
    }
    // add the filter
    add_filter("get_blogs_of_user", "weplugins_modify_get_blogs_of_user_conditionally", 10, 3);
    

Contact Us

If you’re having any trouble using this hook, please contact us and we’d be happy to assist you.