How to use customize_nav_menu_available_items filter in WordPress

customize_nav_menu_available_items filter

Filters the available menu items.

To use customize_nav_menu_available_items 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_customize_nav_menu_available_items_defaults which takes 4 parameters and we registered using add_filter. The first parameter customize_nav_menu_available_items is the name of the hook, The second parameter modify_customize_nav_menu_available_items_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.

Sometime, you have to remove a registered hook so you can use remove_filter to remove customize_nav_menu_available_items filter.

Parameters

Below are the 4 parameters required to use this hook.

• $items : (array) The array of menu items.
• $object_type : (string) The object type.
• $object_name : (string) The object name.
• $page : (int) The current page number.

Live Example

apply_filters( 'customize_nav_menu_available_items', array $items, string $object_type, string $object_name, int $page )

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

    function weplugins_modify_customize_nav_menu_available_items_defaults($items, $object_type, $object_name, $page) { 
        // Update the $items variable according to your website requirements and return this variable. You can modify the $items variable conditionally too if you want.
        return $items; 
    }
    // add the filter
    add_filter( "customize_nav_menu_available_items", "weplugins_modify_customize_nav_menu_available_items_defaults", 10, 4 );
    

Example 1: Add Custom Item to Menu

This example adds a custom item to the menu items.

    function weplugins_add_custom_menu_item($items, $object_type, $object_name, $page) { 
        $items[] = array(
            'title' => 'Custom Item',
            'url' => '#'
        );
        return $items; 
    }
    add_filter( "customize_nav_menu_available_items", "weplugins_add_custom_menu_item", 10, 4 );
    

Example 2: Modify Existing Menu Items

In this example, we modify existing menu items conditionally.

    function weplugins_modify_existing_menu_items($items, $object_type, $object_name, $page) { 
        foreach ($items as &$item) {
            if ($item['title'] == 'Home') {
                $item['title'] = 'Homepage';
            }
        }
        return $items; 
    }
    add_filter( "customize_nav_menu_available_items", "weplugins_modify_existing_menu_items", 10, 4 );
    

Example 3: Remove Specific Menu Item

This example removes a specific item from the menu items.

    function weplugins_remove_specific_menu_item($items, $object_type, $object_name, $page) { 
        foreach ($items as $key => $item) {
            if ($item['title'] == 'Custom Item') {
                unset($items[$key]);
            }
        }
        return $items; 
    }
    add_filter( "customize_nav_menu_available_items", "weplugins_remove_specific_menu_item", 10, 4 );
    

Removing the Hook

To remove a hook callback, use the example below.

remove_filter( "customize_nav_menu_available_items", "weplugins_modify_customize_nav_menu_available_items_defaults", 10, 4 );

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 WordPress Development Team and we’d be happy to assist you.