Changeset 7578

Timestamp:

11/16/2013 01:08:49 AM (11 years ago)

Author:

johnjamesjacoby

Message:

Allow non-core components to hook into notifications via a filter. This allows components that are not registered as part of the main BuddyPress singleton to hook a callback into a filter instead. See #5148.

Location:

trunk/bp-notifications

Files:

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

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

@@ -148 +148 @@
         }
 
-        // Skip inactive components
-        if ( ! bp_is_active( $component_name ) ) {
-            continue;
-        }
-
         // Loop through each actionable item and try to map it to a component
         foreach ( (array) $action_arrays as $component_action_name => $component_action_items ) {
@@ -168 +163 @@
 
                 // Function should return an object
-                if ( 'object' == $format ) {
+                if ( 'object' === $format ) {
 
                     // Retrieve the content of the notification using the callback
@@ -205 +200 @@
             } elseif ( isset( $bp->{$component_name}->format_notification_function ) && function_exists( $bp->{$component_name}->format_notification_function ) ) {
                 $renderable[] = call_user_func( $bp->{$component_name}->format_notification_function, $component_action_name, $component_action_items[0]->item_id, $component_action_items[0]->secondary_item_id, $action_item_count );
+
+            // Allow non BuddyPress components to hook in
+            } else {
+
+                // The array to reference with apply_filters_ref_array()
+                $ref_array = array(
+                    $component_action_name,
+                    $component_action_items[0]->item_id,
+                    $component_action_items[0]->secondary_item_id,
+                    $action_item_count,
+                    $format
+                );
+
+                // Function should return an object
+                if ( 'object' === $format ) {
+
+                    // Retrieve the content of the notification using the callback
+                    $content = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', $ref_array );
+
+                    // Create the object to be returned
+                    $notification_object = new stdClass;
+
+                    // Minimal backpat with non-compatible notification
+                    // callback functions
+                    if ( is_string( $content ) ) {
+                        $notification_object->content = $content;
+                        $notification_object->href    = bp_loggedin_user_domain();
+                    } else {
+                        $notification_object->content = $content['text'];
+                        $notification_object->href    = $content['link'];
+                    }
+
+                    $notification_object->id = $component_action_items[0]->id;
+                    $renderable[]            = $notification_object;
+
+                // Return an array of content strings
+                } else {
+                    $renderable[] = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', $ref_array );
+                }
             }
         }

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

@@ -691 +691 @@
         $notification = $bp->notifications->query_loop->notification;
 
-        // Skip inactive components
-        if ( ! bp_is_active( $notification->component_name ) ) {
-            return;
-        }
-
         // Callback function exists
         if ( isset( $bp->{ $notification->component_name }->notification_callback ) && is_callable( $bp->{ $notification->component_name }->notification_callback ) ) {
@@ -703 +698 @@
         } elseif ( isset( $bp->{ $notification->component_name }->format_notification_function ) && function_exists( $bp->{ $notification->component_name }->format_notification_function ) ) {
             $description = call_user_func( $bp->{ $notification->component_name }->format_notification_function, $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1 );
+
+        // Allow non BuddyPress components to hook in
+        } else {
+            $description = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', array( $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1 ) );
         }