bp_core_avatar_dir

Filters the avatar directory to use.

Description

apply_filters( 'bp_core_avatar_dir', (string) $params_avatar_dir, (string) $params_object, (array) $params ); 

Parameters (3)

0. $params_avatar_dir (string)
Name of the subdirectory where the requested avatar should be found.
1. $params_object (string)
Avatar type being requested.
2. $params (array)
Array of parameters for the request.

Usage

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

Defined (2)

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

/bp-core/bp-core-avatars.php  
  1. $params['avatar_dir'] = apply_filters( 'bp_core_avatar_dir', $params['avatar_dir'], $params['object'], $params ); 
  1. $avatar_dir = apply_filters( 'bp_core_avatar_dir', $avatar_dir, $object );