This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
get_custom_logo_image_attributes filter
Filters the list of custom logo image attributes. To use get_custom_logo_image_attributes 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 modify_get_custom_logo_image_attributes_defaults
which takes 3 parameters and we registered using add_filter. The first parameter get_custom_logo_image_attributes
is the name of the hook, the second parameter modify_get_custom_logo_image_attributes_defaults
is the name of the function that 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 get_custom_logo_image_attributes filter.
Parameters
Below are the 3 parameters required to use this hook.
- $custom_logo_attr: (array) Custom logo image attributes.
- $custom_logo_id: (int) Custom logo attachment ID.
- $blog_id: (int) ID of the blog to get the custom logo for.
Example 1: Basic Usage
Below is an example of how you can use this hook.
function weplugins_modify_get_custom_logo_image_attributes_defaults($custom_logo_attr, $custom_logo_id, $blog_id) { // Update the $custom_logo_attr variable according to your website requirements and return this variable. You can modify the $custom_logo_attr variable conditionally too if you want. return $custom_logo_attr; } // add the filter add_filter( "get_custom_logo_image_attributes", "weplugins_modify_get_custom_logo_image_attributes_defaults", 10, 3 );
Example 2: Removing a Hook Callback
To remove a hook callback, use the example below.
remove_filter( "get_custom_logo_image_attributes", "weplugins_modify_get_custom_logo_image_attributes_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 Logic
Here’s how you can conditionally modify the logo attributes based on specific criteria.
function weplugins_conditional_logo_attributes($custom_logo_attr, $custom_logo_id, $blog_id) { if ($blog_id === 1) { $custom_logo_attr['class'] .= ' special-logo'; } return $custom_logo_attr; } add_filter( "get_custom_logo_image_attributes", "weplugins_conditional_logo_attributes", 10, 3 );
Contact Us
If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.
Explore the latest in WordPress
Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.