Changeset 12008 for trunk/src/bp-templates/bp-nouveau/includes/groups/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/groups/functions.php (modified) (7 diffs)

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

@@ -208 +208 @@
     }
 
+    /**
+     * Filters the response value for potential group invite data for use with javascript.
+     *
+     * @since 3.0.0
+     *
+     * @param array   $response Array of invite data.
+     * @param WP_User $user User object.
+     */
     return apply_filters( 'bp_nouveau_prepare_group_potential_invites_for_js', $response, $user );
 }
@@ -601 +609 @@
      * Fires after inside the group header item meta section.
      *
-     * @since 1.2.0 (BuddyPress)
+     * @since 1.2.0
      */
     do_action( 'bp_group_header_meta' );
@@ -843 +851 @@
     }
 
+    /**
+     * Filters the BuddyPress Nouveau template hierarchy after resetting front template for groups.
+     *
+     * @since 3.0.0
+     *
+     * @param array $templates Array of templates.
+     */
     return apply_filters( '_bp_nouveau_group_reset_front_template', $templates );
 }
@@ -896 +911 @@
     }
 
+    /**
+     * Filters the found template parts for the group template part locating functionality.
+     *
+     * @since 3.0.0
+     *
+     * @param array $templates Array of found templates.
+     */
     return bp_locate_template( apply_filters( 'bp_nouveau_group_locate_template_part', $templates ), false, true );
 }
@@ -916 +938 @@
 
         /**
-         * Let plugins adding an action to bp_get_template_part get it from here
+         * Let plugins adding an action to bp_get_template_part get it from here.
+         *
+         * This is a variable hook that is dependent on the template part slug.
+         *
+         * @since 3.0.0
          *
          * @param string $slug Template part slug requested.
@@ -1002 +1028 @@
     add_filter( 'bp_before_has_members_parse_args', 'bp_nouveau_group_members_widget_overrides', 10, 1 );
 
+    /**
+     * Fires after BuddyPress Nouveau groups have added their home widget filters.
+     *
+     * @since 3.0.0
+     */
     do_action( 'bp_nouveau_groups_add_home_widget_filters' );
 }
@@ -1015 +1046 @@
     remove_filter( 'bp_before_has_members_parse_args', 'bp_nouveau_group_members_widget_overrides', 10, 1 );
 
+    /**
+     * Fires after BuddyPress Nouveau groups have removed their home widget filters.
+     *
+     * @since 3.0.0
+     */
     do_action( 'bp_nouveau_groups_remove_home_widget_filters' );
 }