pre_get_avatar_data

Filters whether to retrieve the avatar URL early.

Description

apply_filters( 'pre_get_avatar_data', (array) $args, (mixed) $id_or_email ); 

Passing a non-null value in the url member of the return array will effectively short circuit get_avatar_data(), passing the value through the filter and returning early.

Parameters (2)

0. $args (array)
Arguments passed to get_avatar_data(), after processing.
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.

Usage

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

Defined (1)

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

/wp-includes/link-template.php  
  1. $args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );