bp_core_avatar_alt

Filters the alt attribute value to be applied to avatar.

Description

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

Parameters (4)

0. $item_name (string)
Alt to be applied to avatar.
1. $params_item_id (string)
ID of avatar item being requested.
2. $params_object (string)
Avatar type being requested.
3. $params (array)
Array of parameters for the request.

Usage

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

Defined (1)

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

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