How to use make_ham_user action in WordPress

make_ham_user action

Fires after the user is marked as a HAM user (opposite of SPAM).

To use the make_ham_user action, first you have to register it using add_action. You can write this code into the 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_make_ham_user_event which takes 1 parameter and we registered using add_action. The first parameter make_ham_user is the name of the hook, the second parameter weplugins_execute_on_make_ham_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 make_ham_user action.

Parameters

Below is the 1 parameter required to use this hook.

• $user_id: (int) ID of the user marked as HAM.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_make_ham_user_event($user_id){
        // 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("make_ham_user", "weplugins_execute_on_make_ham_user_event", 10, 1);
    

Live Example 2: Logging User Activity

This example logs the user activity when they are marked as HAM.

    function weplugins_log_ham_user_activity($user_id){
        error_log("User with ID " . $user_id . " marked as HAM.");
    }
    // Add the action
    add_action("make_ham_user", "weplugins_log_ham_user_activity", 10, 1);
    

Live Example 3: Sending Notification

This example sends an email notification to the admin when a user is marked as HAM.

    function weplugins_notify_admin_ham_user($user_id){
        $admin_email = get_option('admin_email');
        wp_mail($admin_email, "User Marked as HAM", "User with ID " . $user_id . " has been marked as HAM.");
    }
    // Add the action
    add_action("make_ham_user", "weplugins_notify_admin_ham_user", 10, 1);
    

To remove a hook callback, use the example below.

remove_action("make_ham_user", "weplugins_execute_on_make_ham_user_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’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.