How to use get_site filter in WordPress

get_site Filter

Fires after a site is retrieved.

To use the `get_site` 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_site_defaults` which takes 1 parameter and we registered it using `add_filter`. The first parameter `get_site` is the name of the hook, the second parameter `weplugins_modify_get_site_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_site` filter.

Parameters

Below the 1 parameter is required to use this hook.

• $_site : (WP_Site) Site data.

Live Example 1

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

        function weplugins_modify_get_site_defaults($_site) { 
            // Update the $_site variable according to your website requirements and return this variable. You can modify the $_site variable conditionally too if you want.
            return $_site; 
        }
        // add the filter
        add_filter("get_site", "weplugins_modify_get_site_defaults", 10, 1);
    

Live Example 2

To remove a hook callback, use the example below.

        remove_filter("get_site", "weplugins_modify_get_site_defaults", 10, 1);
    

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

Live Example 3

Another example to modify site data conditionally.

        function weplugins_modify_get_site_based_on_id($_site) {
            if ($_site->id == 1) {
                // Modify the site details for site ID 1
                $_site->blogname = 'My Custom Blog Name';
            }
            return $_site;
        }
        // add the filter
        add_filter("get_site", "weplugins_modify_get_site_based_on_id", 10, 1);
    

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