pre_user_email

Filters a user's email before the user is created or updated.

Description

apply_filters( 'pre_user_email', (string) $raw_user_email ); 

Parameters (1)

0. $raw_user_email (string)
The raw user email.

Usage

To run the hook, copy the example below.
  1. $raw_user_email = apply_filters( 'pre_user_email', $raw_user_email ); 
  2.  
  3. if ( !empty( $raw_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 pre_user_email callback 
  2. function filter_pre_user_email( $raw_user_email ) { 
  3. // make filter magic happen here... 
  4. return $raw_user_email
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'pre_user_email', 'filter_pre_user_email', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'pre_user_email', 'filter_pre_user_email', 10, 1 ); 

Defined (1)

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

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