Changeset 9154 for trunk/src/bp-friends/bp-friends-screens.php

Timestamp:

11/18/2014 01:07:17 PM (9 years ago)

Author:

boonebgorges

Message:

Hook documentation for part of the Friends component.

Includes bp-friends-activity, bp-friends-widgets, and bp-friends-screens.

Props tw2113.
See #5942.

File:

• trunk/src/bp-friends/bp-friends-screens.php (modified) (3 diffs)

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

@@ -20 +20 @@
 function friends_screen_my_friends() {
 
+    /**
+     * Fires before the loading of template for the My Friends page.
+     *
+     * @since BuddyPress (1.0.0)
+     */
     do_action( 'friends_screen_my_friends' );
 
+    /**
+     * Filters the template used to display the My Friends page.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param string $template Path to the my friends template to load.
+     */
     bp_core_load_template( apply_filters( 'friends_template_my_friends', 'members/single/home' ) );
 }
@@ -63 +75 @@
     }
 
+    /**
+     * Fires before the loading of template for the friends requests page.
+     *
+     * @since BuddyPress (1.0.0)
+     */
     do_action( 'friends_screen_requests' );
 
+    /**
+     * Filters the template used to display the My Friends page.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param string $template Path to the friends request template to load.
+     */
     bp_core_load_template( apply_filters( 'friends_template_requests', 'members/single/home' ) );
 }
@@ -103 +127 @@
             </tr>
 
-            <?php do_action( 'friends_screen_notification_settings' ); ?>
+            <?php
+
+            /**
+             * Fires after the last table row on the friends notification screen.
+             *
+             * @since BuddyPress (1.0.0)
+             */
+            do_action( 'friends_screen_notification_settings' ); ?>
 
         </tbody>