xprofile_field_order_by_before_save

The BuddyPress xprofile field order by before save hook.

Description

apply_filters( 'xprofile_field_order_by_before_save', (unknown) $this_order_by, (unknown) $this_id ); 

Parameters (2)

0. $this_order_by (unknown)
The this order by.
1. $this_id (unknown)
The this id.

Usage

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

Defined (1)

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

/bp-xprofile/classes/class-bp-xprofile-field.php  
  1. $this->order_by = apply_filters( 'xprofile_field_order_by_before_save', $this->order_by, $this->id );