How to use adminmenu action in WordPress

adminmenu action

Fires after the admin menu has been output.

To use adminmenu action, first you have to register it using add_action. 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 weplugins_execute_on_adminmenu_event and we registered using add_action. The first parameter adminmenu is the name of the hook, The second parameter weplugins_execute_on_adminmenu_event 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_action to remove the adminmenu action.

Parameters

• No parameters

Live Example

do_action( 'adminmenu' )

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

        function weplugins_execute_on_adminmenu_event(){
            //You can write code here to be executed when this action occurs in WordPress website according to your requirements.
        }
        // add the action
        add_action( "adminmenu", "weplugins_execute_on_adminmenu_event");
    

Example 1: Custom Admin Menu Item

In this example, we add a custom item to the admin menu.

        function weplugins_add_custom_admin_menu_item() {
            add_menu_page(
                'Custom Menu Title', // Page title
                'Custom Menu',       // Menu title
                'manage_options',    // Capability
                'custom-menu-slug',  // Menu slug
                'custom_menu_callback' // Callback function
            );
        }
        add_action( 'adminmenu', 'weplugins_add_custom_admin_menu_item' );
    

Example 2: Remove Default Admin Menu Item

This example shows how to remove a default admin menu item.

        function weplugins_remove_admin_menu_item() {
            remove_menu_page( 'edit.php' ); // Removes 'Posts' menu item
        }
        add_action( 'adminmenu', 'weplugins_remove_admin_menu_item' );
    

Example 3: Modify Admin Menu Item

Here, we modify an existing admin menu item.

        function weplugins_modify_admin_menu_item() {
            global $menu;
            foreach ( $menu as $key => $value ) {
                if ( $value[2] == 'edit.php' ) {
                    $menu[$key][0] = 'Modified Posts';
                }
            }
        }
        add_action( 'adminmenu', 'weplugins_modify_admin_menu_item' );
    

To remove a hook callback, use the example below.

remove_action( "adminmenu", "weplugins_execute_on_adminmenu_event");

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