How to use get_site_icon_url filter in WordPress

get_site_icon_url filter

Filters the site icon URL.

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

Parameters

Below are the 3 parameters required to use this hook:

• $url: (string) Site icon URL.
• $size: (int) Size of the site icon.
• $blog_id: (int) ID of the blog to get the site icon for.

Live Example 1

Applying the filter:

apply_filters( 'get_site_icon_url', string $url, int $size, int $blog_id )

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

    function weplugins_modify_get_site_icon_url_defaults($url, $size, $blog_id) {
        // Update the $url variable according to your website requirements and return this variable. You can modify the $url variable conditionally too if you want.
        return $url;
    }
    // add the filter
    add_filter( "get_site_icon_url", "weplugins_modify_get_site_icon_url_defaults", 10, 3 );
    

Live Example 2

To remove a hook callback, use the example below:

    remove_filter( "get_site_icon_url", "weplugins_modify_get_site_icon_url_defaults", 10, 3 );
    

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 of modifying the site icon URL conditionally:

    function weplugins_modify_get_site_icon_url_conditional($url, $size, $blog_id) {
        if ($blog_id == 1) {
            $url = 'https://example.com/custom-icon.png';
        }
        return $url;
    }
    add_filter( "get_site_icon_url", "weplugins_modify_get_site_icon_url_conditional", 10, 3 );
    

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.