bp_docs_activity_pulse

The BuddyPress Docs bp docs activity pulse hook.

Description

apply_filters( 'bp_docs_activity_pulse', (unknown) $pulse ); 

Parameters (1)

0. $pulse (unknown)
The pulse.

Usage

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

Defined (1)

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

/includes/edit-lock.php  
  1. $pulse = intval( apply_filters( 'bp_docs_activity_pulse', $pulse ) );