bboss_global_search_class_search_list

The BuddyPress Global Search bboss global search class list hook.

Description

apply_filters( 'bboss_global_search_class_search_list', (string) $bboss_results_list, (unknown) $label ); 

Parameters (2)

0. $bboss_results_list (string) => 'bboss-results-list'
The bboss results list.
1. $label (unknown)
The label.

Usage

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

Defined (2)

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

/includes/class.BBoss_Global_Search_Helper.php  
  1. . "<ul id='{$type}-stream' class='item-list {$type}-list ". apply_filters( 'bboss_global_search_class_search_list', 'bboss-results-list', $label ) ."'>"; 
  1. . "<ul id='{$args['search_subset']}-stream' class='item-list {$args['search_subset']}-list ". apply_filters( 'bboss_global_search_class_search_list', 'bboss-results-list', $args['search_subset'] ) ."'>";