bp_core_get_notifications_for_user

Filters the final array of notifications to be displayed for a user.

Description

apply_filters( 'bp_core_get_notifications_for_user', (array|bool) $renderable, (int) $user_id, (string) $format ); 

Parameters (3)

0. $renderable (array|bool)
Array of notifications to render or false if no notifications.
1. $user_id (int)
ID of the user whose notifications are being displayed.
2. $format (string)
Display format requested for the notifications.

Usage

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

Defined (1)

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

/bp-notifications/bp-notifications-functions.php  
  1. return apply_filters( 'bp_core_get_notifications_for_user', $renderable, $user_id, $format );