How to use is_email_address_unsafe filter in WordPress

is_email_address_unsafe Filter

Filters whether an email address is unsafe.

To use is_email_address_unsafe 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 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_modify_is_email_address_unsafe_defaults which takes 2 parameters and we registered using add_filter. The first parameter is_email_address_unsafe is the name of the hook. The second parameter weplugins_modify_is_email_address_unsafe_defaults 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_filter to remove is_email_address_unsafe filter.

Parameters

Below are the 2 parameters required to use this hook.

• $is_email_address_unsafe: (bool) Whether the email address is “unsafe”. Default false.
• $user_email: (string) User email address.

Live Example

apply_filters( 'is_email_address_unsafe', bool $is_email_address_unsafe, string $user_email )

Example 1: Basic Usage

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

    function weplugins_modify_is_email_address_unsafe_defaults($is_email_address_unsafe, $user_email) { 
        // Update the $is_email_address_unsafe variable according to your website requirements and return this variable. You can modify the $is_email_address_unsafe variable conditionally too if you want.
        return $is_email_address_unsafe; 
    }
    // add the filter
    add_filter("is_email_address_unsafe", "weplugins_modify_is_email_address_unsafe_defaults", 10, 2); 
    

Example 2: Conditional Modification

In this example, we modify the $is_email_address_unsafe variable based on a specific condition.

    function weplugins_modify_is_email_address_unsafe_defaults($is_email_address_unsafe, $user_email) {
        if (strpos($user_email, 'unsafe-domain.com') !== false) {
            $is_email_address_unsafe = true;
        }
        return $is_email_address_unsafe;
    }
    // add the filter
    add_filter("is_email_address_unsafe", "weplugins_modify_is_email_address_unsafe_defaults", 10, 2);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("is_email_address_unsafe", "weplugins_modify_is_email_address_unsafe_defaults", 10, 2);
    

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 team and we’d be happy to assist you.