How to use icon_dirs filter in WordPress

icon_dirs filter

Filters the array of icon directory URIs.

To use the icon_dirs 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 modify_icon_dirs_defaults which takes 1 parameter and we registered using add_filter. The first parameter icon_dirs is the name of the hook, the second parameter modify_icon_dirs_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 icon_dirs filter.

Parameters

Below the 1 parameter is required to use this hook.

• $uris: (string[]) Array of icon directory URIs keyed by directory absolute path.

Live Example

apply_filters('icon_dirs', string[] $uris)

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

Example 1: Modify Icon Directories

This example demonstrates how to modify the array of icon directory URIs.

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

Example 2: Conditional Modification

This example showcases how to conditionally modify the icon directories based on specific criteria.

function weplugins_conditional_icon_dirs($uris) { 
    if (is_admin()) {
        // Modify $uris for admin area
        $uris[] = 'path/to/admin/icons';
    } else {
        // Modify $uris for front-end
        $uris[] = 'path/to/frontend/icons';
    }
    return $uris; 
}
// add the filter
add_filter('icon_dirs', 'weplugins_conditional_icon_dirs', 10, 1);

Example 3: Removing the Filter

To remove a hook callback, use the example below.

remove_filter('icon_dirs', 'weplugins_modify_icon_dirs_defaults', 10, 1);

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, please contact our team and we’d be happy to assist you.