How to use nav_menu_description filter in WordPress

nav_menu_description Filter

Filters a navigation menu item’s description.

To use the nav_menu_description 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.

WePlugins always prefers 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_nav_menu_description_defaults which takes 1 parameter and we registered it using add_filter. The first parameter nav_menu_description is the name of the hook, the second parameter weplugins_modify_nav_menu_description_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 nav_menu_description filter.

Parameters

Below the 1 parameter is required to use this hook.

• $description : (string) The menu item description.

Live Example

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

Example 1: Basic Usage

This example demonstrates a basic usage of the nav_menu_description filter where the description remains unchanged.

    function weplugins_modify_nav_menu_description_defaults($description) { 
        return $description; 
    }
    // add the filter
    add_filter("nav_menu_description", "weplugins_modify_nav_menu_description_defaults", 10, 1);
    

Example 2: Custom Description

In this example, we modify the description to add a custom message.

    function weplugins_modify_nav_menu_description_defaults($description) { 
        $description .= ' - Custom Description';
        return $description; 
    }
    // add the filter
    add_filter("nav_menu_description", "weplugins_modify_nav_menu_description_defaults", 10, 1);
    

Example 3: Conditional Modification

This example shows how to modify the description conditionally based on some logic.

    function weplugins_modify_nav_menu_description_defaults($description) {
        if (is_front_page()) {
            $description .= ' - Front Page Special';
        }
        return $description;
    }
    // add the filter
    add_filter("nav_menu_description", "weplugins_modify_nav_menu_description_defaults", 10, 1);
    

Removing a Hook

To remove a hook callback, use the example below.

    remove_filter("nav_menu_description", "weplugins_modify_nav_menu_description_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 need any customization or are having trouble using this hook, please contact us and we’d be happy to assist you.