bp_get_the_profile_field_checkbox_acceptance

The BuddyPress Xprofile Custom Fields Type bp get the profile field checkbox acceptance hook.

Description

apply_filters( 'bp_get_the_profile_field_checkbox_acceptance', (unknown) $html, (unknown) $args_type, (unknown) $this_field_obj_id, (unknown) $checkbox_acceptance ); 

Parameters (4)

0. $html (unknown)
The html.
1. $args_type (unknown)
The args type.
2. $this_field_obj_id (unknown)
The this field obj id.
3. $checkbox_acceptance (unknown)
The checkbox acceptance.

Usage

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

Defined (1)

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

/classes/Bxcft_Field_Type_CheckboxAcceptance.php  
  1. echo apply_filters( 'bp_get_the_profile_field_checkbox_acceptance', $html, $args['type'], $this->field_obj->id, $checkbox_acceptance );