How to use customize_nav_menu_searched_items filter in WordPress

customize_nav_menu_searched_items filter

Filters the available menu items during a search request.

To use customize_nav_menu_searched_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_searched_items_defaults which takes 2 parameters and we registered using add_filter. The first parameter customize_nav_menu_searched_items is the name of the hook, the second parameter modify_customize_nav_menu_searched_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_searched_items filter.

Parameters

Below are the 2 parameters required to use this hook.

• $items: (array) The array of menu items.
• $args: (array) Includes ‘pagenum’ and ‘s’ (search) arguments.

Live Examples

Example 1: Basic Usage

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

    function weplugins_modify_customize_nav_menu_searched_items_defaults($items, $args) { 
        // 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_searched_items", "weplugins_modify_customize_nav_menu_searched_items_defaults", 10, 2);
    

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("customize_nav_menu_searched_items", "weplugins_modify_customize_nav_menu_searched_items_defaults", 10, 2);
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Example 3: Conditional Modification

This example demonstrates how to conditionally modify the menu items based on the search term.

    function weplugins_modify_customize_nav_menu_searched_items_conditional($items, $args) { 
        if (isset($args['s']) && $args['s'] === 'special') {
            // Modify $items array for special search term
        }
        return $items; 
    }
    // add the filter
    add_filter("customize_nav_menu_searched_items", "weplugins_modify_customize_nav_menu_searched_items_conditional", 10, 2);
    

Contact Us

If you need any customization, feel free to contact us.