pre_user_nickname

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

Description

apply_filters( 'pre_user_nickname', (string) $nickname ); 

Parameters (1)

0. $nickname (string)
The user's nickname.

Usage

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

Defined (1)

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

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