Changeset 10077 for trunk/src/bp-activity/bp-activity-actions.php

Timestamp:

08/31/2015 06:51:35 AM (9 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:

• trunk/src/bp-activity/bp-activity-actions.php (modified) (32 diffs)

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

@@ -1 +1 @@
 <?php
-
 /**
  * Action functions are exactly the same as screen functions, however they do
@@ -16 +15 @@
  * Allow core components and dependent plugins to register activity actions.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses do_action() To call 'bp_register_activity_actions' hook.
@@ -25 +24 @@
      * Fires on bp_init to allow core components and dependent plugins to register activity actions.
      *
-     * @since BuddyPress (1.2.0)
+     * @since 1.2.0
      */
     do_action( 'bp_register_activity_actions' );
@@ -34 +33 @@
  * Catch and route requests for single activity item permalinks.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses bp_is_activity_component()
@@ -105 +104 @@
      * Filter the intended redirect url before the redirect occurs for the single activity item.
      *
-     * @since BuddyPress (1.2.2)
+     * @since 1.2.2
      *
      * @param array Array with url to redirect to and activity related to the redirect.
@@ -121 +120 @@
  * Delete specific activity item and redirect to previous page.
  *
- * @since BuddyPress (1.1.0)
+ * @since 1.1.0
  *
  * @param int $activity_id Activity id to be deleted. Defaults to 0.
@@ -164 +163 @@
      * Fires before the deletion so plugins can still fetch information about it.
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param int $activity_id The activity ID.
@@ -180 +179 @@
      * Fires after the deletion so plugins can act afterwards based on the activity.
      *
-     * @since BuddyPress (1.1.0)
+     * @since 1.1.0
      *
      * @param int $activity_id The activity ID.
@@ -198 +197 @@
  * Mark specific activity item as spam and redirect to previous page.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @param int $activity_id Activity id to be deleted. Defaults to 0.
@@ -233 +232 @@
      * Fires before the marking activity as spam so plugins can modify things if they want to.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param int    $activity_id Activity ID to be marked as spam.
@@ -250 +249 @@
      * Fires after the marking activity as spam so plugins can act afterwards based on the activity.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param int $activity_id Activity ID that was marked as spam.
@@ -268 +267 @@
  * Post user/group activity update.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses is_user_logged_in()
@@ -298 +297 @@
      * Filters the content provided in the activity input field.
      *
-     * @since BuddyPress (1.2.0)
+     * @since 1.2.0
      *
      * @param string $value Activity message being posted.
@@ -309 +308 @@
          * Filters the item type that the activity update should be associated with.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @param string $value Item type to associate with.
@@ -321 +320 @@
          * Filters what component the activity is being to.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @param string $value Chosen component to post activity to.
@@ -349 +348 @@
          * Filters activity object for BuddyPress core and plugin authors before posting activity update.
          *
-         * @since BuddyPress (1.2.0)
+         * @since 1.2.0
          *
          * @param string $object  Activity item being associated to.
@@ -372 +371 @@
  * Post new activity comment.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses is_user_logged_in()
@@ -398 +397 @@
      * Filters the activity ID a comment will be in reply to.
      *
-     * @since BuddyPress (1.2.0)
+     * @since 1.2.0
      *
      * @param string $value ID of the activity being replied to.
@@ -407 +406 @@
      * Filters the comment content for a comment reply.
      *
-     * @since BuddyPress (1.2.0)
+     * @since 1.2.0
      *
      * @param string $value Comment content being posted.
@@ -436 +435 @@
  * Mark activity as favorite.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses is_user_logged_in()
@@ -470 +469 @@
  * Remove activity from favorites.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses is_user_logged_in()
@@ -504 +503 @@
  * Load the sitewide activity feed.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @uses bp_is_activity_component()
@@ -536 +535 @@
  * Load a user's personal activity feed.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @uses bp_is_user_activity()
@@ -566 +565 @@
  * Load a user's friends' activity feed.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @uses bp_is_active()
@@ -599 +598 @@
  * Load the activity feed for a user's groups.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses bp_is_active()
@@ -640 +639 @@
  * Load a user's @mentions feed.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses bp_is_user_activity()
@@ -677 +676 @@
  * Load a user's favorites feed.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @uses bp_is_user_activity()
@@ -712 +711 @@
  * Loads Akismet filtering for activity.
  *
- * @since BuddyPress (1.6.0)
- * @since BuddyPress (2.3.0) We only support Akismet 3+.
+ * @since 1.6.0
+ * @since 2.3.0 We only support Akismet 3+.
  */
 function bp_activity_setup_akismet() {
@@ -736 +735 @@
      * Filters if BuddyPress Activity Akismet support has been disabled by another plugin.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param bool $value Return value of bp_is_akismet_active boolean function.
@@ -751 +750 @@
  * AJAX endpoint for Suggestions API lookups.
  *
- * @since BuddyPress (2.1.0)
+ * @since 2.1.0
  */
 function bp_ajax_get_suggestions() {
@@ -783 +782 @@
  * Detect a change in post type status, and initiate an activity update if necessary.
  *
- * @since BuddyPress (2.2.0)
+ * @since 2.2.0
  *
  * @todo Support untrashing better.
@@ -817 +816 @@
              * being untrashed.
              *
-             * @since BuddyPress (2.2.0)
+             * @since 2.2.0
              *
              * @param WP_Post $post Post data.