bp_groups_get_orderby_converted_by_term

Filters the converted 'orderby' term.

Description

apply_filters( 'bp_groups_get_orderby_converted_by_term', (string) $self, (string) $orderby, (string) $r_type ); 

Parameters (3)

0. $self (string) => self::convert_orderby_to_order_by_term( $orderby )
Converted orderby term.
1. $orderby (string)
Original orderby value.
2. $r_type (string)
Parsed type value for the get method.

Usage

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

Defined (1)

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

/bp-groups/classes/class-bp-groups-group.php  
  1. $orderby = apply_filters( 'bp_groups_get_orderby_converted_by_term', self::convert_orderby_to_order_by_term( $orderby ), $orderby, $r['type'] );