How to use pre_get_blogs_of_user filter in WordPress

Sometimes, when working with WordPress, you need to modify or extend the functionality of the platform. One way to do this is by using hooks. Today, let’s dive into the pre_get_blogs_of_user filter.

pre_get_blogs_of_user filter

Returning a non-null value from the filter will effectively short circuit get_blogs_of_user(), returning that value instead.

To use the pre_get_blogs_of_user filter, you first need 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.

At WePlugins, we 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_pre_get_blogs_of_user_defaults which takes 3 parameters and we registered using add_filter. The first parameter pre_get_blogs_of_user is the name of the hook, the second parameter weplugins_modify_pre_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 pre_get_blogs_of_user filter.

Parameters

Below are the 3 parameters required to use this hook.

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

Live Examples

Example 1: Basic Usage

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

function weplugins_modify_pre_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( "pre_get_blogs_of_user", "weplugins_modify_pre_get_blogs_of_user_defaults", 10, 3 );

Example 2: Conditional Modification

In this example, we conditionally modify the $sites variable based on the user ID.

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

Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter( "pre_get_blogs_of_user", "weplugins_modify_pre_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.

Contact Us

If you’re having any trouble using this hook or need customization, please Contact Us. We’d be happy to assist you.