bp_xprofile_field_get_children

Filters the found children for a field.

Description

apply_filters( 'bp_xprofile_field_get_children', (object) $children, (bool) $for_editing ); 

Parameters (2)

0. $children (object)
Found children for a field.
1. $for_editing (bool)
Whether or not the field is for editing.

Usage

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

Defined (1)

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

/bp-xprofile/classes/class-bp-xprofile-field.php  
  1. return apply_filters( 'bp_xprofile_field_get_children', $children, $for_editing );