Changeset 10383 for trunk/src/bp-groups/bp-groups-template.php

Timestamp:

11/28/2015 03:24:45 AM (9 years ago)

Author:

boonebgorges

Message:

Pass group objects to some group template filters.

A number of group template functions accept a $group parameter, but are
generally used within the group loop, and infer the current group when no
object is explicitly passed to the function. Filter callbacks can generally
assume which group is intended when the filters are invoked within the loop
(by examining the $groups_template global), but this technique doesn't work
when the functions are used outside of the loop, with a $group passed as
a function parameter. In each of these cases, we should be passing the $group
object - whether inferred or explicit.

Props garrett-eclipse.
Fixes #6752.

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (36 diffs)

trunk/src/bp-groups/bp-groups-template.php

@@ -661 +661 @@
          *
          * @since 1.0.0
-         *
-         * @param int $id ID of the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_id', $group->id );
+         * @since 2.5.0 Added the `$group` parameter.
+         *
+         * @param int    $id    ID of the current group in the loop.
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_id', $group->id, $group );
     }
 
@@ -768 +770 @@
          *
          * @since 1.0.0
-         *
-         * @param string $name Name of the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_name', $group->name );
+         * @since 2.5.0 Added the `$group` parameter.
+         *
+         * @param string $name  Name of the current group in the loop.
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_name', $group->name, $group );
     }
 
@@ -812 +816 @@
      *
      * @since 1.0.0
-     *
-     * @param string $type Type for the current group in the loop.
-     */
-    return apply_filters( 'bp_get_group_type', $type );
+     * @since 2.5.0 Added the `$group` parameter.
+     *
+     * @param string $type  Type for the current group in the loop.
+     * @param object $group Group object.
+     */
+    return apply_filters( 'bp_get_group_type', $type, $group );
 }
 /**
@@ -844 +850 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $status Status of the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_status', $group->status );
+         * @param object $group  Group object.
+         */
+        return apply_filters( 'bp_get_group_status', $group->status, $group );
     }
 
@@ -1037 +1045 @@
              *
              * @since 1.0.0
+             * @since 2.5.0 Added the `$group` parameter.
              *
              * @param string $value Determined last active value for the current group.
+             * @param object $group Group object.
              */
-            return apply_filters( 'bp_get_group_last_active', bp_core_time_since( $last_active ) );
+            return apply_filters( 'bp_get_group_last_active', bp_core_time_since( $last_active ), $group );
         }
     }
@@ -1071 +1081 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Permalink for the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_permalink', trailingslashit( bp_get_groups_directory_permalink() . $group->slug . '/' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_permalink', trailingslashit( bp_get_groups_directory_permalink() . $group->slug . '/' ), $group );
     }
 
@@ -1104 +1116 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Permalink for the admin section of the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_admin_permalink', trailingslashit( bp_get_group_permalink( $group ) . 'admin' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_admin_permalink', trailingslashit( bp_get_group_permalink( $group ) . 'admin' ), $group );
     }
 
@@ -1137 +1151 @@
          *
          * @since 1.0.0
-         *
-         * @param string $slug Slug for the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_slug', $group->slug );
+         * @since 2.5.0 Added the `$group` parameter.
+         *
+         * @param string $slug  Slug for the current group in the loop.
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_slug', $group->slug, $group );
     }
 
@@ -1170 +1186 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Description for the current group.
-         */
-        return apply_filters( 'bp_get_group_description', stripslashes($group->description) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_description', stripslashes( $group->description ), $group );
     }
 
@@ -1206 +1224 @@
          * Filters the permalink for the current group in the loop, for use in a textarea.
          *
-         * 'bp_get_group_description_editable' does not have the formatting
-         * filters that 'bp_get_group_description' has, which makes it
-         * appropriate for "raw" editing.
+         * 'bp_get_group_description_editable' does not have the formatting filters that
+         * 'bp_get_group_description' has, which makes it appropriate for "raw" editing.
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $description Description for the current group in the loop.
-         */
-        return apply_filters( 'bp_get_group_description_editable', $group->description );
+         * @param object $group       Group object.
+         */
+        return apply_filters( 'bp_get_group_description_editable', $group->description, $group );
     }
 
@@ -1314 +1333 @@
         }
 
-        return apply_filters( 'bp_get_group_is_public', $group->is_public );
+        /**
+         * Filters whether the current group in the loop is public.
+         *
+         * @since 2.5.0 Added the `$group` parameter.
+         *
+         * @param bool   $public True if the group is public.
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_is_public', $group->is_public, $group );
     }
 
@@ -1344 +1371 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Created date for the current group.
-         */
-        return apply_filters( 'bp_get_group_date_created', bp_core_time_since( strtotime( $group->date_created ) ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_date_created', bp_core_time_since( strtotime( $group->date_created ) ), $group );
     }
 
@@ -1377 +1406 @@
          *
          * @since 1.7.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Username of the group creator.
-         */
-        return apply_filters( 'bp_get_group_creator_username', bp_core_get_user_displayname( $group->creator_id ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_creator_username', bp_core_get_user_displayname( $group->creator_id ), $group );
     }
 
@@ -1410 +1441 @@
          *
          * @since 1.7.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param int $creator_id User ID of the group creator.
-         */
-        return apply_filters( 'bp_get_group_creator_id', $group->creator_id );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_creator_id', $group->creator_id, $group );
     }
 
@@ -1443 +1476 @@
          *
          * @since 1.7.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Permalink of the group creator.
-         */
-        return apply_filters( 'bp_get_group_creator_permalink', bp_core_get_user_domain( $group->creator_id ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_creator_permalink', bp_core_get_user_domain( $group->creator_id ), $group );
     }
 
@@ -1527 +1562 @@
          *
          * @since 1.7.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $avatar Avatar of the group creator.
-         */
-        return apply_filters( 'bp_get_group_creator_avatar', $avatar );
+         * @param object $group  Group object.
+         */
+        return apply_filters( 'bp_get_group_creator_avatar', $avatar, $group );
     }
 
@@ -1679 +1716 @@
      *
      * @since 1.5.0
+     * @since 2.5.0 Added the `$group` parameter.
      *
      * @param array|string $admin_ids List of user IDs for a group's admins.
-     */
-    return apply_filters( 'bp_group_admin_ids', $admin_ids );
+     * @param object       $group     Group object.
+     */
+    return apply_filters( 'bp_group_admin_ids', $admin_ids, $group );
 }
 
@@ -1721 +1760 @@
      *
      * @since 1.5.0
+     * @since 2.5.0 Added the `$group` parameter.
      *
      * @param array|string $admin_ids List of user IDs for a group's moderators.
-     */
-    return apply_filters( 'bp_group_mod_ids', $mod_ids );
+     * @param object       $group     Group object.
+     */
+    return apply_filters( 'bp_group_mod_ids', $mod_ids, $group );
 }
 
@@ -1751 +1792 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Permalink of the Members page for the current group.
-         */
-        return apply_filters( 'bp_get_group_all_members_permalink', bp_get_group_permalink( $group ) . 'members' );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_all_members_permalink', bp_get_group_permalink( $group ) . 'members', $group );
     }
 
@@ -1923 +1966 @@
          *
          * @since 1.0.0
-         *
-         * @param int $total_member_count Total member count for a group.
-         */
-        return apply_filters( 'bp_get_group_total_members', $group->total_member_count );
+         * @since 2.5.0 Added the `$group` parameter.
+         *
+         * @param int    $total_member_count Total member count for a group.
+         * @param object $group              Group object.
+         */
+        return apply_filters( 'bp_get_group_total_members', $group->total_member_count, $group );
     }
 
@@ -1985 +2030 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL permalink for the Forum Page.
-         */
-        return apply_filters( 'bp_get_group_forum_permalink', bp_get_group_permalink( $group ) . 'forum' );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_forum_permalink', bp_get_group_permalink( $group ) . 'forum', $group );
     }
 
@@ -2485 +2532 @@
      *
      * @since 1.0.0
-     *
-     * @param array $value Array of user IDs who are a moderator of the provided group.
-     */
-    return apply_filters( 'bp_group_has_moderators', groups_get_group_mods( $group->id ) );
+     * @since 2.5.0 Added the `$group` parameter.
+     *
+     * @param array  $value Array of user IDs who are a moderator of the provided group.
+     * @param object $group Group object.
+     */
+    return apply_filters( 'bp_group_has_moderators', groups_get_group_mods( $group->id ), $group );
 }
 
@@ -2607 +2656 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL to use for demoting a user to member.
-         */
-        return apply_filters( 'bp_get_group_member_demote_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/demote/' . $user_id, 'groups_demote_member' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_member_demote_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/demote/' . $user_id, 'groups_demote_member' ), $group );
     }
 
@@ -2731 +2782 @@
          *
          * @since 1.2.6
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL to use for removing a member.
-         */
-        return apply_filters( 'bp_get_group_member_remove_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/remove/' . $user_id, 'groups_remove_member' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_member_remove_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/remove/' . $user_id, 'groups_remove_member' ), $group );
     }
 
@@ -2844 +2897 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Action attribute for a group form.
-         */
-        return apply_filters( 'bp_group_form_action', bp_get_group_permalink( $group ) . $page );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_group_form_action', bp_get_group_permalink( $group ) . $page, $group );
     }
 
@@ -2881 +2936 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Action attribute for a group admin form.
-         */
-        return apply_filters( 'bp_group_admin_form_action', bp_get_group_permalink( $group ) . 'admin/' . $page );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_group_admin_form_action', bp_get_group_permalink( $group ) . 'admin/' . $page, $group );
     }
 
@@ -2933 +2990 @@
      *
      * @since 1.2.4
-     *
-     * @param bool $is_member If user is a member of group or not.
-     */
-    return apply_filters( 'bp_group_is_member', !empty( $group->is_member ) );
+     * @since 2.5.0 Added the `$group` parameter.
+     *
+     * @param bool   $is_member If user is a member of group or not.
+     * @param object $group     Group object.
+     */
+    return apply_filters( 'bp_group_is_member', ! empty( $group->is_member ), $group );
 }
 
@@ -2957 +3016 @@
      *
      * @since 2.1.0
-     *
-     * @param bool $is_invited If user has an outstanding group invite.
-     */
-    return apply_filters( 'bp_group_is_invited', ! empty( $group->is_invited ) );
+     * @since 2.5.0 Added the `$group` parameter.
+     *
+     * @param bool   $is_invited If user has an outstanding group invite.
+     * @param object $group      Group object.
+     */
+    return apply_filters( 'bp_group_is_invited', ! empty( $group->is_invited ), $group );
 }
 
@@ -3019 +3080 @@
      *
      * @since 1.5.0
-     *
-     * @param bool $is_invited If user has been from current group.
-     */
-    return (bool) apply_filters( 'bp_group_is_user_banned', $retval );
+     * @since 2.5.0 Added the `$group` parameter.
+     *
+     * @param bool   $is_invited If user has been from current group.
+     * @param object $group      Group object.
+     */
+    return (bool) apply_filters( 'bp_group_is_user_banned', $retval, $group );
 }
 
@@ -3051 +3114 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL for accepting an invitation to a group.
-         */
-        return apply_filters( 'bp_get_group_accept_invite_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() . '/invites/accept/' . $group->id ), 'groups_accept_invite' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_accept_invite_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() . '/invites/accept/' . $group->id ), 'groups_accept_invite' ), $group );
     }
 
@@ -3083 +3148 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL for rejecting an invitation to a group.
-         */
-        return apply_filters( 'bp_get_group_reject_invite_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() . '/invites/reject/' . $group->id ), 'groups_reject_invite' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_reject_invite_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() . '/invites/reject/' . $group->id ), 'groups_reject_invite' ), $group );
     }
 
@@ -3113 +3180 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL for confirming a request to leave a group.
-         */
-        return apply_filters( 'bp_group_leave_confirm_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'leave-group/yes', 'groups_leave_group' ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_group_leave_confirm_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'leave-group/yes', 'groups_leave_group' ), $group );
     }
 
@@ -3143 +3212 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value URL for rejecting a request to leave a group.
-         */
-        return apply_filters( 'bp_get_group_leave_reject_link', bp_get_group_permalink( $group ) );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_get_group_leave_reject_link', bp_get_group_permalink( $group ), $group );
     }
 
@@ -3173 +3244 @@
          *
          * @since 1.0.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $value Action attribute for a group send invite form.
-         */
-        return apply_filters( 'bp_group_send_invite_form_action', bp_get_group_permalink( $group ) . 'send-invites/send' );
+         * @param object $group Group object.
+         */
+        return apply_filters( 'bp_group_send_invite_form_action', bp_get_group_permalink( $group ) . 'send-invites/send', $group );
     }
 
@@ -3253 +3326 @@
          *
          * @since 1.5.0
+         * @since 2.5.0 Added the `$group` parameter.
          *
          * @param string $button HTML button for a new topic.
-         */
-        return bp_get_button( apply_filters( 'bp_get_group_new_topic_button', $button ) );
+         * @param object $group  Group object.
+         */
+        return bp_get_button( apply_filters( 'bp_get_group_new_topic_button', $button, $group ) );
     }
 
@@ -4338 +4413 @@
     }
 
+    /**
+     * Filters the hierarchy of group front templates corresponding to a specific group.
+     *
+     * @since 2.4.0
+     * @since 2.5.0 Added the `$group` parameter.
+     *
+     * @param array  $template_names Array of template paths.
+     * @param object $group          Group object.
+     */
     $template_names = apply_filters( 'bp_groups_get_front_template', array(
         'groups/single/front-id-'     . sanitize_file_name( $group->id )     . '.php',