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

Timestamp:

11/18/2014 01:07:17 PM (10 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-activity.php (modified) (3 diffs)

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 );
 }