How to use navigation_widgets_format filter in WordPress

navigation_widgets_format filter

Filters the HTML format of widgets with navigation links.

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

Parameters

Below the 1 parameter is required to use this hook.

• $format: (string) The type of markup to use in widgets with navigation links. Accepts ‘html5’, ‘xhtml’.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("navigation_widgets_format", "weplugins_modify_navigation_widgets_format_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 for modifying the format conditionally.

    function weplugins_modify_navigation_widgets_format_conditionally($format) {
        if (is_home()) {
            $format = 'html5';
        } else {
            $format = 'xhtml';
        }
        return $format;
    }
    // add the filter
    add_filter("navigation_widgets_format", "weplugins_modify_navigation_widgets_format_conditionally", 10, 1);
    

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.