bp_core_avatar_item_id

Filters the ID of the item being requested.

Description

apply_filters( 'bp_core_avatar_item_id', (string) $params_item_id, (string) $params_object, (array) $params ); 

Parameters (3)

0. $params_item_id (string)
ID of avatar item being requested.
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_item_id = apply_filters( 'bp_core_avatar_item_id', $params_item_id, $params_object, $params ); 
  2.  
  3. if ( !empty( $params_item_id ) ) { 
  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_item_id callback 
  2. function filter_bp_core_avatar_item_id( $params_item_id, $params_object, $params ) { 
  3. // make filter magic happen here... 
  4. return $params_item_id
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_core_avatar_item_id', 'filter_bp_core_avatar_item_id', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_core_avatar_item_id', 'filter_bp_core_avatar_item_id', 10, 3 ); 

Defined (2)

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

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