Changeset 10147 for trunk/src/bp-friends/bp-friends-functions.php

Timestamp:

09/27/2015 05:08:37 AM (11 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the Friends Component.

See #6576.

File:

• trunk/src/bp-friends/bp-friends-functions.php (modified) (18 diffs)

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

@@ -1 +1 @@
 <?php
-
 /**
  * BuddyPress Friends Functions.
@@ -13 +12 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -75 +74 @@
          * The two potential hooks are: friends_friendship_requested, friends_friendship_accepted.
          *
-         * @since BuddyPress (1.0.0)
+         * @since 1.0.0
          *
          * @param int    $id                ID of the pending friendship connection.
@@ -106 +105 @@
          * for the user who canceled the friendship.
          *
-         * @since BuddyPress (1.5.0)
+         * @since 1.5.0
          *
          * @param int $friendship_id    ID of the friendship object, if any, between a pair of users.
@@ -123 +122 @@
          * This is your last chance to do something while the friendship exists.
          *
-         * @since BuddyPress (1.0.0)
+         * @since 1.0.0
          *
          * @param int $friendship_id    ID of the friendship object, if any, between a pair of users.
@@ -137 +136 @@
                  * Fires after the friendship connection is removed.
                  *
-                 * @since BuddyPress (1.8.0)
+                 * @since 1.8.0
                  *
                  * @param int $initiator_userid ID of the friendship initiator.
@@ -173 +172 @@
                  * Fires after a friendship is accepted.
                  *
-                 * @since BuddyPress (1.0.0)
+                 * @since 1.0.0
                  *
                  * @param int    $id                ID of the pending friendship object.
@@ -203 +202 @@
                  * Fires after a friendship request is rejected.
                  *
-                 * @since BuddyPress (1.0.0)
+                 * @since 1.0.0
                  *
                  * @param int                   $friendship_id ID of the pending friendship.
@@ -236 +235 @@
                  * Fires after a friendship request has been withdrawn.
                  *
-                 * @since BuddyPress (1.9.0)
+                 * @since 1.9.0
                  *
                  * @param int                   $friendship_id ID of the friendship.
@@ -307 +306 @@
          * Filters the total friend count for a given user.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @param int $count Total friend count for a given user.
@@ -412 +411 @@
          * Filters a user's most recently active friends.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @param array {
@@ -442 +441 @@
          * Filters a user's friends listed in alphabetical order.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @return array {
@@ -472 +471 @@
          * Filters a user's friends listed from newest to oldest.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @param array {
@@ -502 +501 @@
  * user is not a group admin.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @param int $user_id  User ID whose friends to see can be invited. Default:
@@ -525 +524 @@
          * Filters default arguments for list of friends a user can invite into this group.
          *
-         * @since BuddyPress (1.5.4)
+         * @since 1.5.4
          *
          * @param array $value Array of default parameters for invite list.
@@ -578 +577 @@
          * Filters the list of potential friends that can be invited to this group.
          *
-         * @since BuddyPress (1.5.4)
+         * @since 1.5.4
          *
          * @param array|bool $friends  Array friends available to invite or false for no friends.
@@ -695 +694 @@
          * Fires before deletion of friend-related data for a given user.
          *
-         * @since BuddyPress (1.5.0)
+         * @since 1.5.0
          *
          * @param int $user_id ID for the user whose friend data is being removed.
@@ -709 +708 @@
          * Fires after deletion of friend-related data for a given user.
          *
-         * @since BuddyPress (1.0.0)
+         * @since 1.0.0
          *
          * @param int $user_id ID for the user whose friend data is being removed.