bp_<id>_parse_query

Fires in the parse_query method inside BP_Component.

Description

do_action( 'bp_<id>_parse_query', (array) $array ); 

This is a dynamic hook that is based on the component string ID.

Parameters (1)

0. $array (array) => array( &$query )
Main WP_Query object. Passed by reference.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'bp_{$id}_parse_query', $array ); 
The following example is for adding a hook callback.
  1. // define the bp_<id>_parse_query callback 
  2. function action_bp_id_parse_query( $array ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( "bp_{$id}_parse_query", 'action_bp_id_parse_query', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( "bp_{$id}_parse_query", 'action_bp_id_parse_query', 10, 1 ); 

Defined (1)

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

/bp-core/classes/class-bp-component.php  
  1. do_action_ref_array( 'bp_' . $this->id . '_parse_query', array( &$query ) );