Changeset 10706

Timestamp:

04/14/2016 08:36:39 PM (8 years ago)

Author:

r-a-y

Message:

Messages: Introduce dynamic filter, "bp_messages_{$action}_notification".

This new filter helps plugin developers filter private message
notifications that are not the 'new_message' action.

For backward compatibility, we apply the existing
"bp_messages_{$amount}_new_message_notification" filter just before
adding our new dynamic filter.

Fixes #6750.

Props imath.

File:

• trunk/src/bp-messages/bp-messages-notifications.php (modified) (3 diffs)

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

@@ -104 +104 @@
 function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
     $total_items = (int) $total_items;
+    $text        = '';
     $link        = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/inbox' );
     $title       = __( 'Inbox', 'buddypress' );
@@ -112 +113 @@
             $amount = 'multiple';
             $text   = sprintf( __( 'You have %d new messages', 'buddypress' ), $total_items );
+
         } else {
-            $amount = 'single';
-
             // Get message thread ID.
             $message   = new BP_Messages_Message( $item_id );
@@ -128 +128 @@
             }
         }
-    }
-
-    if ( 'string' === $format ) {
-        if ( ! empty( $link ) ) {
-            $retval = '<a href="' . esc_url( $link ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $text ) . '</a>';
+
+        if ( 'string' === $format ) {
+            if ( ! empty( $link ) ) {
+                $return = '<a href="' . esc_url( $link ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $text ) . '</a>';
+            } else {
+                $return = esc_html( $text );
+            }
+
+            /**
+             * Filters the new message notification text before the notification is created.
+             *
+             * This is a dynamic filter. Possible filter names are:
+             *   - 'bp_messages_multiple_new_message_notification'.
+             *   - 'bp_messages_single_new_message_notification'.
+             *
+             * @param string $return            Notification text.
+             * @param int    $total_items       Number of messages referred to by the notification.
+             * @param string $text              The raw notification test (ie, not wrapped in a link).
+             * @param int    $item_id           ID of the associated item.
+             * @param int    $secondary_item_id ID of the secondary associated item.
+             */
+            $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', $return, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
         } else {
-            $retval = esc_html( $text );
+            /** This filter is documented in bp-messages/bp-messages-notifications.php */
+            $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', array(
+                'text' => $text,
+                'link' => $link
+            ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+        }
+
+    // Custom notification action for the Messages component
+    } else {
+        if ( 'string' === $format ) {
+            $return = $text;
+        } else {
+            $return = array(
+                'text' => $text,
+                'link' => $link
+            );
         }
 
         /**
-         * Filters the new message notification text before the notification is created.
+         * Backcompat for plugins that used to filter bp_messages_single_new_message_notification
+         * for their custom actions. These plugins should now use 'bp_messages_' . $action . '_notification'
+         */
+        if ( has_filter( 'bp_messages_single_new_message_notification' ) ) {
+            if ( 'string' === $format ) {
+                /** This filter is documented in bp-messages/bp-messages-notifications.php */
+                $return = apply_filters( 'bp_messages_single_new_message_notification', $return, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+
+            // Notice that there are seven parameters instead of six? Ugh...
+            } else {
+                /** This filter is documented in bp-messages/bp-messages-notifications.php */
+                $return = apply_filters( 'bp_messages_single_new_message_notification', $return, $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+            }
+        }
+
+        /**
+         * Filters the custom action notification before the notification is created.
          *
-         * This is a dynamic filter. Possible filter names are:
-         *   - 'bp_messages_multiple_new_message_notification'.
-         *   - 'bp_messages_single_new_message_notification'.
+         * This is a dynamic filter based on the message notification action.
          *
-         * @param string $retval            Notification text.
-         * @param int    $total_items       Number of messages referred to by the notification.
-         * @param string $text              The raw notification test (ie, not wrapped in a link).
+         * @since 2.6.0
+         *
+         * @param array  $value             An associative array containing the text and the link of the notification
          * @param int    $item_id           ID of the associated item.
          * @param int    $secondary_item_id ID of the secondary associated item.
+         * @param int    $total_items       Number of messages referred to by the notification.
+         * @param string $format            Return value format. 'string' for BuddyBar-compatible
+         *                                  notifications; 'array' for WP Toolbar. Default: 'string'.
          */
-        $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', $retval, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
-    } else {
-        /** This filter is documented in bp-messages/bp-messages-notifications.php */
-        $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', array(
-            'text' => $text,
-            'link' => $link
-        ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+        $return = apply_filters( "bp_messages_{$action}_notification", $return, $item_id, $secondary_item_id, $total_items, $format );
     }