How to use invite_user action in WordPress

invite_user action

Fires immediately after an existing user is invited to join the site, but before the notification is sent.

To use the invite_user 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_invite_user_event which takes 3 parameters and we registered using add_action. The first parameter invite_user is the name of the hook, the second parameter weplugins_execute_on_invite_user_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 invite_user action.

Parameters

Below are the 3 parameters required to use this hook.

• $user_id: (int) The invited user’s ID.
• $role: (array) Array containing role information for the invited user.
• $newuser_key: (string) The key of the invitation.

Live Example

Example 1: Basic Usage

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

    function weplugins_execute_on_invite_user_event($user_id, $role, $newuser_key){
        // You can write code here to be executed when this action occurs in WordPress. Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action("invite_user", "weplugins_execute_on_invite_user_event", 10, 3);
    

Example 2: Logging Invited User Information

This example logs the invited user’s information for auditing purposes.

    function weplugins_log_invited_user($user_id, $role, $newuser_key) {
        error_log("User ID: $user_id, Role: " . implode(',', $role) . ", Key: $newuser_key");
    }
    add_action("invite_user", "weplugins_log_invited_user", 10, 3);
    

Example 3: Sending a Custom Notification

In this example, we send a custom notification to the site admin when a user is invited.

    function weplugins_notify_admin_on_invite($user_id, $role, $newuser_key) {
        $admin_email = get_option('admin_email');
        $subject = "New User Invited";
        $message = "User ID: $user_id, Role: " . implode(',', $role) . ", Key: $newuser_key";
        wp_mail($admin_email, $subject, $message);
    }
    add_action("invite_user", "weplugins_notify_admin_on_invite", 10, 3);
    

To remove a hook callback, use the example below.

    remove_action("invite_user", "weplugins_execute_on_invite_user_event", 10, 3);
    

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.