Changeset 10790

Timestamp:

05/19/2016 05:58:25 PM (9 years ago)

Author:

r-a-y

Message:

Notifications: Pass the notification ID to the notification format callback.

When formatting notifications for a component, there are some cases where
you might want to reference the notification ID.

This is especially important if you want to grab some notification meta
without having to re-query just for the notification ID.

This commit adds the notification ID to our notification format callbacks:

• For those registered by the BP_Component class ($bp->COMPONENT->notification_callback)
• For non-BP components via the 'bp_notifications_get_notifications_for_user' filter.

Fixes #7066.

Location:

trunk/src/bp-notifications

Files:

• bp-notifications-functions.php (modified) (5 diffs)
• bp-notifications-template.php (modified) (2 diffs)

trunk/src/bp-notifications/bp-notifications-functions.php

@@ -234 +234 @@
                         $component_action_items[0]->secondary_item_id,
                         $action_item_count,
-                        'array'
+                        'array',
+                        $component_action_items[0]->id
                     );
 
@@ -254 +255 @@
                 // Return an array of content strings.
                 } else {
-                    $content      = call_user_func( $bp->{$component_name}->notification_callback, $component_action_name, $component_action_items[0]->item_id, $component_action_items[0]->secondary_item_id, $action_item_count );
+                    $content      = call_user_func( $bp->{$component_name}->notification_callback, $component_action_name, $component_action_items[0]->item_id, $component_action_items[0]->secondary_item_id, $action_item_count, $component_action_items[0]->id );
                     $renderable[] = $content;
                 }
@@ -273 +274 @@
                     $format,
                     $component_action_name, // Duplicated so plugins can check the canonical action name.
-                    $component_name
+                    $component_name,
+                    $component_action_items[0]->id
                 );
 
@@ -287 +289 @@
                      *
                      * @since 1.9.0
-                     * @since 2.6.0 Added $component_action_name and $component_name as parameters.
+                     * @since 2.6.0 Added $component_action_name, $component_name, $id as parameters.
                      *
                      * @param string $content               Component action. Deprecated. Do not do checks against this! Use
@@ -297 +299 @@
                      * @param string $component_action_name Canonical notification action.
                      * @param string $component_name        Notification component ID.
+                     * @param int    $id                    Notification ID.
                      *
                      * @return string|array If $format is 'string', return a string of the notification content.

trunk/src/bp-notifications/bp-notifications-template.php

@@ -472 +472 @@
         // Callback function exists.
         if ( isset( $bp->{ $notification->component_name }->notification_callback ) && is_callable( $bp->{ $notification->component_name }->notification_callback ) ) {
-            $description = call_user_func( $bp->{ $notification->component_name }->notification_callback, $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1 );
+            $description = call_user_func( $bp->{ $notification->component_name }->notification_callback, $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1, 'string', $notification->id );
 
         // @deprecated format_notification_function - 1.5
@@ -482 +482 @@
 
             /** This filter is documented in bp-notifications/bp-notifications-functions.php */
-            $description = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', array( $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1, 'string', $notification->component_action, $notification->component_name ) );
+            $description = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', array( $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1, 'string', $notification->component_action, $notification->component_name, $notification->id ) );
         }