How to use get_custom_logo filter in WordPress

get_custom_logo filter

Filters the custom logo output.

To use the get_custom_logo filter, you first 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 modify_get_custom_logo_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_custom_logo is the name of the hook, the second parameter modify_get_custom_logo_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_custom_logo filter.

Parameters

Below are the 2 parameters required to use this hook.

• $html : (string) Custom logo HTML output.
• $blog_id : (int) ID of the blog to get the custom logo for.

Live Examples

Example 1: Filter the output of logo to fix Google’s Error about itemprop logo

This example shows how to filter the output of the custom logo to fix Google’s error about the itemprop logo.

    add_filter( 'get_custom_logo', 'weplugins_com' );
    function weplugins_com() {
        $custom_logo_id = get_theme_mod( 'custom_logo' );
        $html = sprintf( '<a href="%1$s" class="custom-logo-link" rel="home" itemprop="url">%2$s</a>',
                esc_url( home_url( '/' ) ),
                wp_get_attachment_image( $custom_logo_id, 'full', false, array(
                    'class'    => 'custom-logo',
                ) )
            );
        return $html;   
    }
    

Example 2: Modify Custom Logo HTML Output

Below is an example of how you can use this hook to modify the custom logo HTML output.

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

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_custom_logo", "weplugins_modify_get_custom_logo_defaults", 10, 2 );
    

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.