bp_get_the_profile_field_description

Filters the XProfile field description.

Description

apply_filters( 'bp_get_the_profile_field_description', (string) $field_description ); 

Parameters (1)

0. $field_description (string)
Description for the profile field.

Usage

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

Defined (1)

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

/bp-xprofile/bp-xprofile-template.php  
  1. return apply_filters( 'bp_get_the_profile_field_description', $field->description );