Changeset 10184

Timestamp:

10/04/2015 01:47:36 PM (9 years ago)

Author:

imath

Message:

Improve template loading for Groups single items home pages.

• Make sure an activity sub navigation will be generated if the displayed group has a custom front page.
• Make sure no members sub navigation is generated if the activity component is not active and the Group has no custom front. As, in this case the home page of the group is already displaying the members template.
• Make sure some Groups single item conditional tags are behaving the right way:
  • bp_is_group_home() is true when on the home page of the group (eg: site.url/groups/single-group/).
  • bp_is_group_activity() is true when the activity page of the group is displayed. It can be the home page of the group or its activity page (eg: site.url/groups/single-group/activity).
  • bp_is_group_members() is true when the members page of the group is displayed. It can be the home page of the group or its members page (eg: site.url/groups/single-group/members).
• Introduce a new conditional tag: bp_is_group_custom_front() to check if the home page of the group is using a custom front template.
• Introduce a new template tag bp_groups_front_template_part() used to choose the appropriate template to load for the home page of the group (activity, members, or the custom front).
• Introduce a template hierarchy for the buddypress/groups/single/front.php template so that it is possible to have different front pages according to the ID, slug or status of the Group.
• And finally make sure the introduced improvements are back compatible with themes who forgot to update their buddypress/groups/single/home.php and buddypress/activity/post-form.php templates.

Props r-a-y, boonebgorges, DJPaul, and imath :)

Fixes #6388

Location:

trunk/src

Files:

• bp-activity/bp-activity-functions.php (modified) (2 diffs)
• bp-core/bp-core-template.php (modified) (3 diffs)
• bp-groups/bp-groups-filters.php (modified) (1 diff)
• bp-groups/bp-groups-loader.php (modified) (3 diffs)
• bp-groups/bp-groups-screens.php (modified) (1 diff)
• bp-groups/bp-groups-template.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress-functions.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/activity/post-form.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/groups/single/home.php (modified) (1 diff)

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

@@ -3105 +3105 @@
  * @uses bp_is_activity_directory() to check if the current page is the activity
  *       directory.
- * @uses bp_is_active() to check if the group component is active.
  * @uses bp_is_group_activity() to check if on a single group, the current page
  *       is the group activities.
- * @uses bp_is_group_home() to check if the current page is a single group home
- *       page.
  *
  * @return bool True if activity heartbeat is enabled, otherwise false.
@@ -3120 +3117 @@
     }
 
-    if ( bp_is_activity_directory() ) {
+    if ( bp_is_activity_directory() || bp_is_group_activity() ) {
         $retval = true;
     }
 
-    if ( bp_is_active( 'groups') ) {
-        // If no custom front, then activities are loaded in group's home
-        $has_custom_front = bp_locate_template( array( 'groups/single/front.php' ), false, true );
-
-        if ( bp_is_group_activity() || ( ! $has_custom_front && bp_is_group_home() ) ) {
-            $retval = true;
-        }
-    }
-
     return $retval;
 }

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

@@ -2553 +2553 @@
  */
 function bp_is_group_activity() {
-    return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'activity' ) );
+    $retval = false;
+
+    if ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'activity' ) ) {
+        $retval = true;
+    }
+
+    if ( bp_is_group_home() && bp_is_active( 'activity' ) && ! bp_is_group_custom_front() ) {
+        $retval = true;
+    }
+
+    return $retval;
 }
 
@@ -2586 +2596 @@
  */
 function bp_is_group_members() {
-    return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'members' ) );
+    $retval = false;
+
+    if ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'members' ) ) {
+        $retval = true;
+    }
+
+    if ( bp_is_group_home() && ! bp_is_active( 'activity' ) && ! bp_is_group_custom_front() ) {
+        $retval = true;
+    }
+
+    return $retval;
 }
 
@@ -2631 +2651 @@
 function bp_is_group_single() {
     return (bool) ( bp_is_groups_component() && bp_is_single_item() );
+}
+
+/**
+ * Is the current group page a custom front?
+ *
+ * @since 2.4.0
+ *
+ * @return bool True if the current group page is a custom front.
+ */
+function bp_is_group_custom_front() {
+    $bp = buddypress();
+    return (bool) bp_is_group_home() && ! empty( $bp->groups->current_group->front_template );
 }
 

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

@@ -270 +270 @@
     }
 
-    if ( $load_mentions || ( bp_is_group_activity() || bp_is_group_home() ) ) {
+    if ( $load_mentions || bp_is_group_activity() ) {
         return true;
     }

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

@@ -251 +251 @@
                 $this->current_group->user_has_access = true;
             }
+
+            // Check once if the current group has a custom front template
+            $this->current_group->front_template = bp_groups_get_front_template( $this->current_group );
 
         // Set current_group to 0 to prevent debug errors
@@ -372 +375 @@
         $bp = buddypress();
 
+        // If the activity component is not active and the current group has no custom front, members are displayed in the home nav
+        if ( 'members' === $this->default_extension && ! bp_is_active( 'activity' ) && ! $this->current_group->front_template ) {
+            $this->default_extension = 'home';
+        }
+
         if ( ! bp_current_action() ) {
             $bp->current_action = $this->default_extension;
@@ -528 +536 @@
             }
 
-            $sub_nav[] = array(
-                'name'            => sprintf( _x( 'Members <span>%s</span>', 'My Group screen nav', 'buddypress' ), number_format( $this->current_group->total_member_count ) ),
-                'slug'            => 'members',
-                'parent_url'      => $group_link,
-                'parent_slug'     => $this->current_group->slug,
-                'screen_function' => 'groups_screen_group_members',
-                'position'        => 60,
-                'user_has_access' => $this->current_group->user_has_access,
-                'item_css_id'     => 'members',
-                'no_access_url'   => $group_link,
-            );
+            if ( $this->current_group->front_template || bp_is_active( 'activity' ) ) {
+                /**
+                 * If the theme is using a custom front, create activity subnav.
+                 */
+                if ( $this->current_group->front_template && bp_is_active( 'activity' ) ) {
+                    $sub_nav[] = array(
+                        'name'            => _x( 'Activity', 'My Group screen nav', 'buddypress' ),
+                        'slug'            => 'activity',
+                        'parent_url'      => $group_link,
+                        'parent_slug'     => $this->current_group->slug,
+                        'screen_function' => 'groups_screen_group_activity',
+                        'position'        => 11,
+                        'user_has_access' => $this->current_group->user_has_access,
+                        'item_css_id'     => 'activity',
+                        'no_access_url'   => $group_link,
+                    );
+                }
+
+                /**
+                 * Only add the members subnav if it's not the home's nav
+                 */
+                $sub_nav[] = array(
+                    'name'            => sprintf( _x( 'Members <span>%s</span>', 'My Group screen nav', 'buddypress' ), number_format( $this->current_group->total_member_count ) ),
+                    'slug'            => 'members',
+                    'parent_url'      => $group_link,
+                    'parent_slug'     => $this->current_group->slug,
+                    'screen_function' => 'groups_screen_group_members',
+                    'position'        => 60,
+                    'user_has_access' => $this->current_group->user_has_access,
+                    'item_css_id'     => 'members',
+                    'no_access_url'   => $group_link,
+                );
+            }
 
             if ( bp_is_active( 'friends' ) && bp_groups_user_can_send_invites() ) {

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

@@ -739 +739 @@
      */
     bp_core_load_template( apply_filters( 'groups_template_group_request_membership', 'groups/single/home' ) );
+}
+
+/**
+ * Handle the loading of a single group's activity.
+ *
+ * @since 2.4.0
+ */
+function groups_screen_group_activity() {
+
+    if ( ! bp_is_single_item() ) {
+        return false;
+    }
+
+    /**
+     * Fires before the loading of a single group's activity page.
+     *
+     * @since 2.4.0
+     */
+    do_action( 'groups_screen_group_activity' );
+
+    /**
+     * Filters the template to load for a single group's activity page.
+     *
+     * @since 2.4.0
+     *
+     * @param string $value Path to a single group's template to load.
+     */
+    bp_core_load_template( apply_filters( 'groups_screen_group_activity', 'groups/single/activity' ) );
 }
 

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

@@ -4344 +4344 @@
 
 /**
+ * Output the contents of the current group's home page.
+ *
+ * You should only use this when on a single group page.
+ *
+ * @since 2.4.0
+ */
+function bp_groups_front_template_part() {
+    $located = bp_groups_get_front_template();
+
+    if ( false !== $located ) {
+        $slug = str_replace( '.php', '', $located );
+
+        /**
+         * Let plugins adding an action to bp_get_template_part get it from here
+         *
+         * @param string $slug Template part slug requested.
+         * @param string $name Template part name requested.
+         */
+        do_action( 'get_template_part_' . $slug, $slug, false );
+
+        load_template( $located, true );
+
+    } else if ( bp_is_active( 'activity' ) ) {
+        bp_get_template_part( 'groups/single/activity' );
+
+    } else if ( bp_is_active( 'members'  ) ) {
+        bp_groups_members_template_part();
+    }
+
+    return $located;
+}
+
+/**
+ * Locate a custom group front template if it exists.
+ *
+ * @since 2.4.0
+ *
+ * @param  BP_Groups_Group|null $group Optional. Falls back to current group if not passed.
+ * @return string|bool                 Path to front template on success; boolean false on failure.
+ */
+function bp_groups_get_front_template( $group = null ) {
+    if ( ! is_a( $group, 'BP_Groups_Group' ) ) {
+        $group = groups_get_current_group();
+    }
+
+    if ( ! isset( $group->id ) ) {
+        return false;
+    }
+
+    if ( isset( $group->front_template ) ) {
+        return $group->front_template;
+    }
+
+    $template_names = apply_filters( 'bp_groups_get_front_template', array(
+        'groups/single/front-id-'     . sanitize_file_name( $group->id )     . '.php',
+        'groups/single/front-slug-'   . sanitize_file_name( $group->slug )   . '.php',
+        'groups/single/front-status-' . sanitize_file_name( $group->status ) . '.php',
+        'groups/single/front.php'
+    ) );
+
+    return bp_locate_template( $template_names, false, true );
+}
+
+/**
  * Output the Group members template
  *

trunk/src/bp-templates/bp-legacy/buddypress-functions.php

@@ -929 +929 @@
 
     $activity_id = 0;
-    if ( empty( $_POST['object'] ) && bp_is_active( 'activity' ) ) {
+    $item_id     = 0;
+    $object      = '';
+
+
+    // Try to get the item id from posted variables.
+    if ( ! empty( $_POST['item_id'] ) ) {
+        $item_id = (int) $_POST['item_id'];
+    }
+
+    // Try to get the object from posted variables.
+    if ( ! empty( $_POST['object'] ) ) {
+        $object  = sanitize_key( $_POST['object'] );
+
+    // If the object is not set and we're in a group, set the item id and the object
+    } elseif ( bp_is_group() ) {
+        $item_id = bp_get_current_group_id();
+        $object = 'groups';
+    }
+
+    if ( ! $object && bp_is_active( 'activity' ) ) {
         $activity_id = bp_activity_post_update( array( 'content' => $_POST['content'] ) );
 
-    } elseif ( $_POST['object'] == 'groups' ) {
-        if ( ! empty( $_POST['item_id'] ) && bp_is_active( 'groups' ) )
-            $activity_id = groups_post_update( array( 'content' => $_POST['content'], 'group_id' => $_POST['item_id'] ) );
+    } elseif ( 'groups' === $object ) {
+        if ( $item_id && bp_is_active( 'groups' ) )
+            $activity_id = groups_post_update( array( 'content' => $_POST['content'], 'group_id' => $item_id ) );
 
     } else {
 
         /** This filter is documented in bp-activity/bp-activity-actions.php */
-        $activity_id = apply_filters( 'bp_activity_custom_update', false, $_POST['object'], $_POST['item_id'], $_POST['content'] );
+        $activity_id = apply_filters( 'bp_activity_custom_update', false, $object, $item_id, $_POST['content'] );
     }
 

trunk/src/bp-templates/bp-legacy/buddypress/activity/post-form.php

@@ -67 +67 @@
                 <input type="hidden" id="whats-new-post-object" name="whats-new-post-object" value="groups" />
 
-            <?php elseif ( bp_is_group_home() ) : ?>
+            <?php elseif ( bp_is_group_activity() ) : ?>
 
                 <input type="hidden" id="whats-new-post-object" name="whats-new-post-object" value="groups" />

trunk/src/bp-templates/bp-legacy/buddypress/groups/single/home.php

@@ -78 +78 @@
                 if ( bp_group_is_visible() ) {
 
-                    // Use custom front if one exists
-                    $custom_front = bp_locate_template( array( 'groups/single/front.php' ), false, true );
-                    if     ( ! empty( $custom_front   ) ) : load_template( $custom_front, true );
-
-                    // Default to activity
-                    elseif ( bp_is_active( 'activity' ) ) : bp_get_template_part( 'groups/single/activity' );
-
-                    // Otherwise show members
-                    elseif ( bp_is_active( 'members'  ) ) : bp_groups_members_template_part();
-
-                    endif;
+                    // Load appropriate front template
+                    bp_groups_front_template_part();
 
                 } else {