bxcft_field_actual_image

The BuddyPress Xprofile Custom Fields Type bxcft field actual image hook.

Description

apply_filters( 'bxcft_field_actual_image', (unknown) $actual_image, (unknown) $bp_get_the_profile_field_id, (unknown) $bp_get_the_profile_field_type, (string) $bp_get_the_profile_field_input_name, (unknown) $bp_get_the_profile_field_edit_value ); 

Parameters (5)

0. $actual_image (unknown)
The actual image.
1. $bp_get_the_profile_field_id (unknown) => bp_get_the_profile_field_id()
The bp get the profile field id.
2. $bp_get_the_profile_field_type (unknown) => bp_get_the_profile_field_type()
The bp get the profile field type.
3. $bp_get_the_profile_field_input_name (string) => bp_get_the_profile_field_input_name()
The bp get the profile field input name.
4. $bp_get_the_profile_field_edit_value (unknown) => bp_get_the_profile_field_edit_value()
The bp get the profile field edit value.

Usage

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

Defined (1)

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

/classes/Bxcft_Field_Type_Image.php  
  1. echo apply_filters('bxcft_field_actual_image', $actual_image, bp_get_the_profile_field_id(), bp_get_the_profile_field_type(), bp_get_the_profile_field_input_name(), bp_get_the_profile_field_edit_value());