bp_core_validate_email_address( string $user_email )

Check that an email address is valid for use.

Description

Performs the following checks:

Is the email address well-formed?
Is the email address already used?
If there’s an email domain blacklist, is the current domain on it?
If there’s an email domain whitelest, is the current domain on it?

Parameters

$user_email: (Required) The email being checked.

Return

(bool|array) True if the address passes all checks; otherwise an array of error codes.

Source

File: bp-members/bp-members-functions.php

function bp_core_validate_email_address( $user_email ) {
    $errors = array();
 
    $user_email = sanitize_email( $user_email );
 
    // Is the email well-formed?
    if ( ! is_email( $user_email ) ) {
        $errors['invalid'] = 1;
    }
 
    // Is the email on the Banned Email Domains list?
    // Note: This check only works on Multisite.
    if ( function_exists( 'is_email_address_unsafe' ) && is_email_address_unsafe( $user_email ) ) {
        $errors['domain_banned'] = 1;
    }
 
    // Is the email on the Limited Email Domains list?
    // Note: This check only works on Multisite.
    $limited_email_domains = get_site_option( 'limited_email_domains' );
    if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
        $emaildomain = substr( $user_email, 1 + strpos( $user_email, '@' ) );
        if ( ! in_array( $emaildomain, $limited_email_domains ) ) {
            $errors['domain_not_allowed'] = 1;
        }
    }
 
    // Is the email alreday in use?
    if ( email_exists( $user_email ) ) {
        $errors['in_use'] = 1;
    }
 
    $retval = ! empty( $errors ) ? $errors : true;
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.6.2	Introduced.

Used By
Used By	Description
bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::update_general_fields()	Update general fields.
bp-settings/actions/general.php: bp_settings_action_general()	Handles the changing and saving of user email addresses and passwords.
bp-members/bp-members-functions.php: bp_core_validate_user_signup()	Validate a user name and email address when creating a new user.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents