Changeset 9286

Timestamp:

12/29/2014 06:07:00 AM (10 years ago)

Author:

tw2113

Message:

Adding hooks documentation for bp-xprofile-activity.php.

See #5949

File:

• trunk/src/bp-xprofile/bp-xprofile-activity.php (modified) (6 diffs)

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

@@ -43 +43 @@
     );
 
+    /**
+     * Fires after the registration of default activity actions for Extended Profile component.
+     *
+     * @since BuddyPress (1.1.0)
+     */
     do_action( 'xprofile_register_activity_actions' );
 }
@@ -65 +70 @@
     }
 
+    /**
+     * Filters the formatted 'new_avatar' activity stream action.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param string $action   Formatted action for activity stream.
+     * @param object $activity Activity object.
+     */
     return apply_filters( 'bp_xprofile_format_activity_action_new_avatar', $action, $activity );
 }
@@ -86 +99 @@
     $action       = sprintf( __( '%s&#8217;s profile was updated', 'buddypress' ), '<a href="' . $profile_link . '">' . bp_core_get_user_displayname( $activity->user_id ) . '</a>' );
 
+    /**
+     * Filters the formatted 'updated_profile' activity stream action.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param string $action   Formatted action for activity stream.
+     * @param object $activity Activity object.
+     */
     return apply_filters( 'bp_xprofile_format_activity_action_updated_profile', $action, $activity );
 }
@@ -167 +188 @@
     }
 
+    /**
+     * Filters the return value of bp_activity_set_action.
+     *
+     * @since BuddyPress (1.1.0)
+     *
+     * @param bool   $value Whether or not an action was successfully registered.
+     * @param string $key   Key used for the registered action.
+     * @param string $value Value used for the registered action.
+     */
     return apply_filters( 'xprofile_register_activity_action', bp_activity_set_action( buddypress()->profile->id, $key, $value ), $key, $value );
 }
@@ -186 +216 @@
     }
 
-    // Allow user ID to be filtered
+    /**
+     * Filters the user ID when a user has ploaded a new avatar.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $value ID of the displayed user.
+     */
     $user_id = apply_filters( 'bp_xprofile_new_avatar_user_id', bp_displayed_user_id() );
 
@@ -263 +299 @@
     // Default throttle time is 2 hours. Filter to change (in seconds)
     if ( ! empty( $existing['activities'] ) ) {
+
+        /**
+         * Filters the throttle time, in seconds, used to prevent excessive activity posting.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param int $value Throttle time, in seconds.
+         */
         $throttle_period = apply_filters( 'bp_xprofile_updated_profile_activity_throttle_time', HOUR_IN_SECONDS * 2 );
         $then            = strtotime( $existing['activities'][0]->date_recorded );