Changeset 9352 for trunk/src/bp-notifications/bp-notifications-screens.php

Timestamp:

01/13/2015 01:35:21 AM (12 years ago)

Author:

tw2113

Message:

Adds hooks documentation to the BP-Notifications component.

Fixes #5946.

File:

• trunk/src/bp-notifications/bp-notifications-screens.php (modified) (2 diffs)

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

@@ -21 +21 @@
  */
 function bp_notifications_screen_unread() {
+
+        /**
+         * Fires right before the loading of the notifications unread screen template file.
+         *
+         * @since BuddyPress (1.9.0)
+         */
         do_action( 'bp_notifications_screen_unread' );
 
+        /**
+         * Filters the template to load for the notifications unread screen.
+         *
+         * @since BuddyPress (1.9.0)
+         *
+         * @param string $template Path to the notifications unread template to load.
+         */
         bp_core_load_template( apply_filters( 'bp_notifications_template_unread', 'members/single/home' ) );
 }
@@ -32 +45 @@
  */
 function bp_notifications_screen_read() {
+
+        /**
+         * Fires right before the loading of the notifications read screen template file.
+         *
+         * @since BuddyPress (1.9.0)
+         */
         do_action( 'bp_notifications_screen_read' );
 
+        /**
+         * Filters the template to load for the notifications read screen.
+         *
+         * @since BuddyPress (1.9.0)
+         *
+         * @param string $template Path to the notifications read template to load.
+         */
         bp_core_load_template( apply_filters( 'bp_notifications_template_read', 'members/single/home' ) );
 }