Changeset 12008 for trunk/src/bp-templates/bp-nouveau/includes/activity/functions.php

Timestamp:

04/28/2018 01:32:52 AM (8 years ago)

Author:

tw2113

Message:

add/touchup documentation to a lot of Nouveau actions and filters

File:

• trunk/src/bp-templates/bp-nouveau/includes/activity/functions.php (modified) (5 diffs)

trunk/src/bp-templates/bp-nouveau/includes/activity/functions.php

@@ -90 +90 @@
 
     /**
-     * Filter to include specific Action buttons.
+     * Filters the included, specific, Action buttons.
      *
      * @since 3.0.0
@@ -145 +145 @@
         }
 
+        /**
+         * Filters the activity objects to apply for localized javascript data.
+         *
+         * @since 3.0.0
+         *
+         * @param array $activity_objects Array of activity objects.
+         */
         $activity_params['objects'] = apply_filters( 'bp_nouveau_activity_objects', $activity_objects );
     }
@@ -276 +283 @@
 
     /**
+     * Filters the activity directory navigation items.
+     *
      * Use this filter to introduce your custom nav items for the activity directory.
      *
@@ -418 +427 @@
 
         // Leave other components do their specific stuff if needed.
+        /**
+         * Filters the classes to be applied to the newest activity item.
+         *
+         * Leave other components do their specific stuff if needed.
+         *
+         * @since 3.0.0
+         *
+         * @param array  $my_classes Array of classes to output to class attribute.
+         * @param string $scope      Current scope for the activity type.
+         */
         $my_classes = (array) apply_filters( 'bp_nouveau_activity_scope_newest_class', $my_classes, $scope );
 
@@ -444 +463 @@
 
     /**
-     * Filter to edit the activity widget arguments
+     * Filter to edit the activity widget arguments.
      *
      * @since 3.0.0
      *
-     * @param  array $args The activity arguments.
+     * @param array $args The activity arguments.
      */
     return apply_filters( 'bp_nouveau_activity_widget_query', $args );