Changeset 9208 for trunk/src/bp-messages/bp-messages-notifications.php

Timestamp:

12/03/2014 03:27:09 PM (12 years ago)

Author:

boonebgorges

Message:

Assemble message notification filters dynamically.

This allows us to centralize the documentation.

Props tw2113.
See #5970.

File:

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

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

@@ -129 +129 @@
         if ( 'new_message' === $action ) {
                 if ( $total_items > 1 ) {
+                        $amount = 'multiple';
                         $text   = sprintf( __( 'You have %d new messages', 'buddypress' ), $total_items );
-                        $filter = 'bp_messages_multiple_new_message_notification';
                 } else {
+                        $amount = 'single';
+
                         // get message thread ID
                         $message   = new BP_Messages_Message( $item_id );
@@ -144 +146 @@
                                 $text = sprintf( _n( 'You have %s new private message', 'You have %s new private messages', $total_items, 'buddypress' ), bp_core_number_format( $total_items ) );
                         }
-                        $filter = 'bp_messages_single_new_message_notification';
                 }
         }
@@ -154 +155 @@
                         $retval = esc_html( $text );
                 }
-                $return = apply_filters( $filter, $retval, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+
+                /**
+                 * 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 $retval            Notification text.
+                 * @param int    $total_items       Number of messages referred to by the notification.
+                 * @param string $text              The raw notification test (ie, not wrappen 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', $retval, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
         } else {
-                $return = apply_filters( $filter, array(
+                /** 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