pre_user_first_name

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

Description

apply_filters( 'pre_user_first_name', (string) $first_name ); 

Parameters (1)

0. $first_name (string)
The user's first name.

Usage

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

Defined (1)

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

/wp-includes/user.php  
  1. $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );