bp_groups_get_orderby

Filters the 'type' parameter used to overwrite 'order' and 'orderby' values.

Description

apply_filters( 'bp_groups_get_orderby', (array) $self, (string) $r_type ); 

Parameters (2)

0. $self (array) => self::convert_type_to_order_orderby( $r['type'] )
Converted type value for order and orderby.
1. $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', $self, $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 callback 
  2. function filter_bp_groups_get_orderby( $self, $r_type ) { 
  3. // make filter magic happen here... 
  4. return $self
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_groups_get_orderby', 'filter_bp_groups_get_orderby', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_groups_get_orderby', 'filter_bp_groups_get_orderby', 10, 2 ); 

Defined (1)

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

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