How to use grant_super_admin action in WordPress

grant_super_admin action

Fires before the user is granted Super Admin privileges.

To use grant_super_admin 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 execute_on_grant_super_admin_event which takes 1 parameter and we registered it using add_action. The first parameter grant_super_admin is the name of the hook, the second parameter execute_on_grant_super_admin_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 grant_super_admin action.

Parameters

Below is the 1 parameter required to use this hook.

• $user_id: (int) ID of the user that is about to be granted Super Admin privileges.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_grant_super_admin_event($user_id){
       //You can write code here to be executed when this action occurs in WordPress.
    }
    // add the action
    add_action("grant_super_admin", "weplugins_execute_on_grant_super_admin_event", 10, 1);
    

Live Example 2: Logging Super Admin Grants

This example shows how to log the ID of a user when they are granted Super Admin privileges.

    function weplugins_log_super_admin_grant($user_id){
        error_log('User with ID ' . $user_id . ' has been granted Super Admin privileges.');
    }
    add_action("grant_super_admin", "weplugins_log_super_admin_grant", 10, 1);
    

Live Example 3: Sending Notification on Super Admin Grant

In this example, we send an email notification when a user is granted Super Admin privileges.

    function weplugins_notify_super_admin_grant($user_id){
        $user_info = get_userdata($user_id);
        wp_mail('admin@website.com', 'Super Admin Granted', 'User ' . $user_info->user_login . ' has been granted Super Admin privileges.');
    }
    add_action("grant_super_admin", "weplugins_notify_super_admin_grant", 10, 1);
    

To remove a hook callback, use the example below.

    remove_action("grant_super_admin", "weplugins_execute_on_grant_super_admin_event", 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 our WordPress Development Team and we’d be happy to assist you.