bp_xprofile_is_richtext_enabled_for_field

Filters whether richtext is enabled for the given field.

Description

apply_filters( 'bp_xprofile_is_richtext_enabled_for_field', (bool) $enabled, (int) $field_id ); 

Parameters (2)

0. $enabled (bool)
True if richtext is enabled for the field, otherwise false.
1. $field_id (int)
ID of the field.

Usage

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

Defined (1)

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

/bp-xprofile/bp-xprofile-functions.php  
  1. return apply_filters( 'bp_xprofile_is_richtext_enabled_for_field', $enabled, $field_id );