Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use menu_order filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read
Share Via:

menu_order filter

A truthy value must first be passed to the ‘custom_menu_order’ filter for this filter to work. Use the following to enable custom menu ordering:

To use menu_order 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 Flipper Code, 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_menu_order_defaults which takes 1 parameters and we registered using add_filter. The first parameter menu_order is name of the hook, The second parameter modify_menu_order_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if 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 menu_order filter.

Parameters

    Below the 1 parameter is required to use this hook.

  • $menu_order : (array) An ordered array of menu items.

Live Example

add_filter( 'custom_menu_order', '__return_true' );
 add_filter( 'menu_order', 'custom_menu_order' );
 function custom_menu_order() {
    return array( 'index.php', 'edit.php', 'edit-comments.php' );
}

Below is an example how you can use this hook.

                        function modify_menu_order_defaults($menu_order) { 
   
                            // Update the $menu_order variable according to your website requirements and return this variable. You can modify the $menu_order variable conditionally too if you want.

                            return $menu_order; 
                        }
                        // add the filter
                        add_filter( "menu_order", "modify_menu_order_defaults", 10, 1 );

To remove a hook callback, use the example below.

remove_filter( "menu_order", "modify_menu_order_defaults", 10, 1 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.