user_registration_email

Filters the email address of a user being registered.

Description

apply_filters( 'user_registration_email', (string) $user_email ); 

Parameters (1)

0. $user_email (string)
The email address of the new user.

Usage

To run the hook, copy the example below.
  1. $user_email = apply_filters( 'user_registration_email', $user_email ); 
  2.  
  3. if ( !empty( $user_email ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the user_registration_email callback 
  2. function filter_user_registration_email( $user_email ) { 
  3. // make filter magic happen here... 
  4. return $user_email
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'user_registration_email', 'filter_user_registration_email', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'user_registration_email', 'filter_user_registration_email', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/user.php  
  1. $user_email = apply_filters( 'user_registration_email', $user_email );