user_profile_picture_description

Filters the user profile picture description displayed under the Gravatar.

Description

apply_filters( 'user_profile_picture_description', (string) $description, (WP_User) $profileuser ); 

Parameters (2)

0. $description (string)
The description that will be printed.
1. $profileuser (WP_User)
The current WP_User object.

Usage

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

Defined (1)

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

/wp-admin/user-edit.php  
  1. echo apply_filters( 'user_profile_picture_description', $description, $profileuser );