Changeset 7558 for trunk/bp-friends/bp-friends-notifications.php

Timestamp:

11/11/2013 12:52:44 AM (12 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-friends component. See #5022

File:

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

trunk/bp-friends/bp-friends-notifications.php

@@ -14 +14 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Send notifications related to a new friendship request.
+ *
+ * When a friendship is requested, an email and a BP notification are sent to
+ * the user of whom friendship has been requested ($friend_id).
+ *
+ * @param int $friendship_id ID of the friendship object.
+ * @param int $initiator_id ID of the user who initiated the request.
+ * @param int $friend_id ID of the request recipient.
+ */
 function friends_notification_new_request( $friendship_id, $initiator_id, $friend_id ) {
 
@@ -55 +65 @@
 }
 
+/**
+ * Send notifications related to the acceptance of a friendship request.
+ *
+ * When a friendship request is accepted, an email and a BP notification are
+ * sent to the user who requested the friendship ($initiator_id).
+ *
+ * @param int $friendship_id ID of the friendship object.
+ * @param int $initiator_id ID of the user who initiated the request.
+ * @param int $friend_id ID of the request recipient.
+ */
 function friends_notification_accepted_request( $friendship_id, $initiator_id, $friend_id ) {