bp_wp_user_query_args

The BuddyPress bp wp user query args hook.

Description

apply_filters( 'bp_wp_user_query_args', (callback) $array, (unknown) $instance ); 

Parameters (2)

0. $array — Optional. (callback) => array('fields' => $fields, 'include' => $this->user_ids,'blog_id' => 0, 'count_total' => false )
The array.
1. $instance (unknown)
The instance.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-user-query.php  
  1. $wp_user_query = new WP_User_Query( apply_filters( 'bp_wp_user_query_args', array(