Changeset 9154

Timestamp:

11/18/2014 01:07:17 PM (11 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.

Location:

trunk/src/bp-friends

Files:

• bp-friends-activity.php (modified) (3 diffs)
• bp-friends-screens.php (modified) (3 diffs)
• bp-friends-widgets.php (modified) (1 diff)

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

@@ -114 +114 @@
     bp_activity_set_action( $bp->friends->id, 'friends_register_activity_action', __( 'New friendship created', 'buddypress' ) );
 
+    /**
+     * Fires after all default bp-friends activity actions have been registered.
+     *
+     * @since BuddyPress (1.1.0)
+     */
     do_action( 'friends_register_activity_actions' );
 }
@@ -140 +145 @@
     }
 
+    /**
+     * Filters the 'friendship_accepted' activty action format.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param string $action String text for the 'friendship_accepted' action.
+     * @param object $activity Activity data.
+     */
     return apply_filters( 'bp_friends_format_activity_action_friendship_accepted', $action, $activity );
 }
@@ -166 +179 @@
     }
 
+    /**
+     * Filters the 'friendship_created' activty action format.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param string $action String text for the 'friendship_created' action.
+     * @param object $activity Activity data.
+     */
     return apply_filters( 'bp_friends_format_activity_action_friendship_created', $action, $activity );
 }

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>

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

@@ -77 +77 @@
         }
 
+        /**
+         * Filters the Friends widget title.
+         *
+         * @since BuddyPress (1.8.0)
+         *
+         * @param string $title The widget title.
+         */
         $title = apply_filters( 'widget_title', $instance['title'] );