Changeset 11293

Timestamp:

12/12/2016 11:28:17 PM (8 years ago)

Author:

slaffik

Message:

Messages: New filters in BP_Messages_Notice class.

Provide several new filters and actions for different methods, that give ability for plugin developers to further fine-tune Notices in Messages component.

See #5193.

File:

• trunk/src/bp-messages/classes/class-bp-messages-notice.php (modified) (4 diffs)

trunk/src/bp-messages/classes/class-bp-messages-notice.php

@@ -197 +197 @@
         }
 
+        /**
+         * Fires after the current message item has been deleted.
+         *
+         * @since 2.8.0
+         *
+         * @param BP_Messages_Notice $this Current instance of the message notice item being deleted.
+         */
+        do_action( 'messages_notice_after_delete', $this );
+
         return true;
     }
@@ -239 +248 @@
         }
 
-        return $notices;
+        /**
+         * Filters the array of notices, sorted by date and paginated.
+         *
+         * @since 2.8.0
+         *
+         * @param array $r Array of parameters.
+         */
+        return apply_filters( 'messages_notice_get_notices', $notices, $r );
     }
 
@@ -256 +272 @@
         $notice_count = $wpdb->get_var( "SELECT COUNT(id) FROM {$bp->messages->table_name_notices}" );
 
-        return $notice_count;
+        /**
+         * Filters the total number of notices.
+         *
+         * @since 2.8.0
+         */
+        return (int) apply_filters( 'messages_notice_get_total_notice_count', $notice_count );
     }
 
@@ -280 +301 @@
         }
 
-        return $notice;
+        /**
+         * Gives ability to filter the active notice that should be displayed on the front end.
+         *
+         * @since 2.8.0
+         */
+        return apply_filters( 'messages_notice_get_active', $notice );
     }
 }