How to use is_email filter in WordPress

is_email filter

This filter is evaluated under several different contexts, such as ’email_too_short’, ’email_no_at’, ‘local_invalid_chars’, ‘domain_period_sequence’, ‘domain_period_limits’, ‘domain_no_periods’, ‘sub_hyphen_limits’, ‘sub_invalid_chars’, or no specific context.

To use is_email 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 modify_is_email_defaults which takes 3 parameters and we registered using add_filter. The first parameter is_email is name of the hook, the second parameter modify_is_email_defaults is 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 filter.

Parameters

Below are the 3 parameters required to use this hook.

• $is_email: (string|false) The email address if successfully passed the is_email() checks, false otherwise.
• $email: (string) The email address being checked.
• $context: (string) Context under which the email was tested.

Live Example

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

    function weplugins_modify_is_email_defaults($is_email, $email, $context) {
        // Update the $is_email variable according to your website requirements and return this variable. You can modify the $is_email variable conditionally too if you want.
        return $is_email;
    }
    // add the filter
    add_filter("is_email", "weplugins_modify_is_email_defaults", 10, 3);
    

Example 1: Basic Usage

Here is a basic example of how to use the is_email filter to validate an email address.

    function weplugins_modify_is_email_defaults($is_email, $email, $context) {
        // Custom logic for email validation
        if ($context == 'email_no_at') {
            return false;
        }
        return $is_email;
    }
    // add the filter
    add_filter("is_email", "weplugins_modify_is_email_defaults", 10, 3);
    

Example 2: Conditional Modification

This example shows how you can conditionally modify the $is_email variable based on specific requirements.

    function weplugins_modify_is_email_defaults($is_email, $email, $context) {
        if ($context == 'domain_no_periods') {
            return false;
        }
        return $is_email;
    }
    // add the filter
    add_filter("is_email", "weplugins_modify_is_email_defaults", 10, 3);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("is_email", "weplugins_modify_is_email_defaults", 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 team and we’d be happy to assist you.