user_<field>

Filters the value of a user field in a standard context.

Description

apply_filters( 'user_<field>', (mixed) $value, (int) $user_id, (string) $context ); 

The dynamic portion(s) of the hook name refer to the prefixed user field being filtered, such as user_login,, user_email, first_name, etc.

Parameters (3)

0. $value (mixed)
The user object value to sanitize.
1. $user_id (int)
The user id.
2. $context (string)
The context to filter within.

Usage

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

Defined (1)

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

/wp-includes/user.php  
  1. $value = apply_filters( "user_{$field}", $value, $user_id, $context );