bb_query_form_inputs

The BuddyPress bb query form inputs hook.

Description

apply_filters( 'bb_query_form_inputs', (string) $var, (unknown) $args, (unknown) $query_vars ); 

Parameters (3)

0. $var (string) => ''
The var.
1. $args (unknown)
The args.
2. $query_vars (unknown)
The query vars.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/class.bb-query.php  
  1. $r .= apply_filters( 'bb_query_form_inputs', '', $args, $query_vars );