pre_get_avatar

Filters whether to retrieve the avatar URL early.

Description

apply_filters( 'pre_get_avatar', (null) $null, (mixed) $id_or_email, (array) $args ); 

Passing a non-null value will effectively short-circuit get_avatar(), passing the value through the filter and returning early.

Parameters (3)

0. $null (null) => null
HTML for the user's avatar. Default null.
1. $id_or_email (mixed)
The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
2. $args (array)
Arguments passed to get_avatar_url(), after processing.

Usage

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

Defined (1)

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

/wp-includes/pluggable.php  
  1. $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );