Changeset 9127

Timestamp:

11/07/2014 11:31:26 PM (10 years ago)

Author:

imath

Message:

Improve the way Group's Manage tabs are generated

In BP_Group_Extension->setup_edit_hooks() method, we are now using the bp_core_new_subnav_item() function to generate the Group's manage tab sub navigation.
The action 'groups_admin_tabs' is no more used. However for back compatibility reasons, we will keep on catching this hook inviting the user using a _doing_it_wrong message to now use the BuddyPress Group Extension API instead.

props boonebgorges

Fixes #5994

Location:

trunk/src

Files:

• bp-core/bp-core-template.php (modified) (6 diffs)
• bp-groups/bp-groups-classes.php (modified) (2 diffs)
• bp-groups/bp-groups-loader.php (modified) (1 diff)
• bp-groups/bp-groups-template.php (modified) (1 diff)

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

@@ -27 +27 @@
  *       viewed user.
  */
-function bp_get_options_nav() {
+function bp_get_options_nav( $parent_slug = '' ) {
     $bp = buddypress();
 
@@ -33 +33 @@
     // component as an index. Otherwise we need to use the component's root_slug
     $component_index = !empty( $bp->displayed_user ) ? bp_current_component() : bp_get_root_slug( bp_current_component() );
+    $selected_item   = bp_current_action();
 
     if ( ! bp_is_single_item() ) {
@@ -41 +42 @@
         }
     } else {
-        if ( !isset( $bp->bp_options_nav[bp_current_item()] ) || count( $bp->bp_options_nav[bp_current_item()] ) < 1 ) {
+        $current_item = bp_current_item();
+
+        if ( ! empty( $parent_slug ) ) {
+            $current_item  = $parent_slug;
+            $selected_item = bp_action_variable( 0 );
+        }
+
+        if ( !isset( $bp->bp_options_nav[$current_item] ) || count( $bp->bp_options_nav[$current_item] ) < 1 ) {
             return false;
         } else {
-            $the_index = bp_current_item();
+            $the_index = $current_item;
         }
     }
@@ -55 +63 @@
 
         // If the current action or an action variable matches the nav item id, then add a highlight CSS class.
-        if ( $subnav_item['slug'] == bp_current_action() ) {
+        if ( $subnav_item['slug'] == $selected_item ) {
             $selected = ' class="current selected"';
         } else {
@@ -65 +73 @@
 
         // echo out the final list item
-        echo apply_filters( 'bp_get_options_nav_' . $subnav_item['css_id'], '<li id="' . $subnav_item['css_id'] . '-' . $list_type . '-li" ' . $selected . '><a id="' . $subnav_item['css_id'] . '" href="' . $subnav_item['link'] . '">' . $subnav_item['name'] . '</a></li>', $subnav_item );
+        echo apply_filters( 'bp_get_options_nav_' . $subnav_item['css_id'], '<li id="' . $subnav_item['css_id'] . '-' . $list_type . '-li" ' . $selected . '><a id="' . $subnav_item['css_id'] . '" href="' . $subnav_item['link'] . '">' . $subnav_item['name'] . '</a></li>', $subnav_item, $selected_item );
     }
 }
@@ -1918 +1926 @@
         $retval = bp_is_groups_component() && groups_get_current_group();
     }
-    
+
     return (bool) $retval;
 }

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

@@ -3638 +3638 @@
      */
     protected function setup_edit_hooks() {
+        // Bail if not in a group
+        if ( ! bp_is_group() ) {
+            return;
+        }
 
         // Bail if not an edit screen
@@ -3647 +3651 @@
 
         $position = isset( $screen['position'] ) ? (int) $screen['position'] : 10;
-
-        // Add the tab
-        // @todo BP should be using bp_core_new_subnav_item()
-        add_action( 'groups_admin_tabs', create_function( '$current, $group_slug',
-            '$selected = "";
-            if ( "' . esc_attr( $screen['slug'] ) . '" == $current )
-                $selected = " class=\"current\"";
-            echo "<li{$selected}><a href=\"' . trailingslashit( bp_get_root_domain() . '/' . bp_get_groups_root_slug() . '/{$group_slug}/admin/' . esc_attr( $screen['slug'] ) ) . '\">' . esc_attr( $screen['name'] ) . '</a></li>";'
-        ), $position, 2 );
+        $position += 40;
+
+        $current_group = groups_get_current_group();
+        $admin_link = trailingslashit( bp_get_group_permalink( $current_group ) . 'admin' );
+
+        // Add the tab to the manage navigation
+        bp_core_new_subnav_item( array(
+            'name'            => $screen['name'],
+            'slug'            => $screen['slug'],
+            'parent_slug'     => $current_group->slug . '_manage',
+            'parent_url'      => trailingslashit( bp_get_group_permalink( $current_group ) . 'admin' ),
+            'user_has_access' => bp_is_item_admin(),
+            'position'        => $position,
+            'screen_function' => 'groups_screen_group_admin',
+        ) );
 
         // Catch the edit screen and forward it to the plugin template

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

@@ -510 +510 @@
             }
 
+            // If viewing an admin page, create the group admin subnav items
+            if ( bp_is_group_admin_page() ) {
+                $admin_link = trailingslashit( $group_link . 'admin' );
+
+                // Common params to all nav items
+                $default_params = array(
+                    'parent_url'      => $admin_link,
+                    'parent_slug'     => $this->current_group->slug . '_manage',
+                    'screen_function' => 'groups_screen_group_admin',
+                    'user_has_access' => bp_is_item_admin(),
+                );
+
+                $sub_nav[] = array_merge( array(
+                    'name'            => __( 'Details', 'buddypress' ),
+                    'slug'            => 'edit-details',
+                    'position'        => 0,
+                ), $default_params );
+
+                $sub_nav[] = array_merge( array(
+                    'name'            => __( 'Settings', 'buddypress' ),
+                    'slug'            => 'group-settings',
+                    'position'        => 10,
+                ), $default_params );
+
+                if ( ! (int) bp_get_option( 'bp-disable-avatar-uploads' ) && buddypress()->avatar->show_avatars ) {
+                    $sub_nav[] = array_merge( array(
+                        'name'        => __( 'Photo', 'buddypress' ),
+                        'slug'        => 'group-avatar',
+                        'position'    => 20,
+                    ), $default_params );
+                }
+
+                $sub_nav[] = array_merge( array(
+                    'name'            => __( 'Members', 'buddypress' ),
+                    'slug'            => 'manage-members',
+                    'position'        => 30,
+                ), $default_params );
+
+                if ( 'private' == $this->current_group->status ) {
+                    $sub_nav[] = array_merge( array(
+                        'name'            => __( 'Requests', 'buddypress' ),
+                        'slug'            => 'membership-requests',
+                        'position'        => 40,
+                    ), $default_params );
+                }
+
+                $sub_nav[] = array_merge( array(
+                    'name'            => __( 'Delete', 'buddypress' ),
+                    'slug'            => 'delete-group',
+                    'position'        => 1000,
+                ), $default_params );
+            }
+
             parent::setup_nav( $main_nav, $sub_nav );
         }

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

@@ -2300 +2300 @@
     }
 
-    $current_tab = bp_get_group_current_admin_tab();
-
-    if ( bp_is_item_admin() ) : ?>
-
-        <li<?php if ( 'edit-details' == $current_tab || empty( $current_tab ) ) : ?> class="current"<?php endif; ?>><a href="<?php echo trailingslashit( bp_get_group_permalink( $group ) . 'admin/edit-details' ) ?>"><?php _e( 'Details', 'buddypress' ); ?></a></li>
-
-    <?php endif; ?>
-
-    <?php if ( ! bp_is_item_admin() )
-            return false; ?>
-
-    <li<?php if ( 'group-settings' == $current_tab ) : ?> class="current"<?php endif; ?>><a href="<?php echo trailingslashit( bp_get_group_permalink( $group ) . 'admin/group-settings' ) ?>"><?php _e( 'Settings', 'buddypress' ); ?></a></li>
-
-    <?php if ( !(int)bp_get_option( 'bp-disable-avatar-uploads' ) && buddypress()->avatar->show_avatars ) : ?>
-
-        <li<?php if ( 'group-avatar'   == $current_tab ) : ?> class="current"<?php endif; ?>><a href="<?php echo trailingslashit( bp_get_group_permalink( $group ) . 'admin/group-avatar' ) ?>"><?php _e( 'Photo', 'buddypress' ); ?></a></li>
-
-    <?php endif; ?>
-
-    <li<?php if ( 'manage-members' == $current_tab ) : ?> class="current"<?php endif; ?>><a href="<?php echo trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members' ) ?>"><?php _e( 'Members', 'buddypress' ); ?></a></li>
-
-    <?php if ( $groups_template->group->status == 'private' ) : ?>
-
-        <li<?php if ( 'membership-requests' == $current_tab ) : ?> class="current"<?php endif; ?>><a href="<?php echo trailingslashit( bp_get_group_permalink( $group ) . 'admin/membership-requests' ) ?>"><?php _e( 'Requests', 'buddypress' ); ?></a></li>
-
-    <?php endif; ?>
-
-    <?php do_action( 'groups_admin_tabs', $current_tab, $group->slug ) ?>
-
-    <li<?php if ( 'delete-group' == $current_tab ) : ?> class="current"<?php endif; ?>><a href="<?php echo trailingslashit( bp_get_group_permalink( $group ) . 'admin/delete-group' ) ?>"><?php _e( 'Delete', 'buddypress' ); ?></a></li>
-
-<?php
+    $css_id = 'manage-members';
+
+    if ( 'private' == $group->status ) {
+        $css_id = 'membership-requests';
+    }
+
+    add_filter( "bp_get_options_nav_{$css_id}", 'bp_group_admin_tabs_backcompat', 10, 3 );
+
+    bp_get_options_nav( $group->slug . '_manage' );
+
+    remove_filter( "bp_get_options_nav_{$css_id}", 'bp_group_admin_tabs_backcompat', 10, 3 );
+}
+
+/**
+ * BackCompat for plugins/themes directly hooking groups_admin_tabs
+ * without using the Groups Extension API
+ *
+ * @param  string $subnav_output subnav item output
+ * @param  string $subnav_item   subnav item params
+ * @param  string $selected_item current selected tab
+ * @return string HTML output
+ */
+function bp_group_admin_tabs_backcompat( $subnav_output = '', $subnav_item = '', $selected_item = '' ) {
+    if ( ! has_action( 'groups_admin_tabs' ) ) {
+        return $subnav_output;
+    }
+
+    $group = groups_get_current_group();
+
+    ob_start();
+
+    do_action( 'groups_admin_tabs', $selected_item, $group->slug );
+
+    $admin_tabs_backcompat = trim( ob_get_contents() );
+    ob_end_clean();
+
+    if ( ! empty( $admin_tabs_backcompat ) ) {
+        _doing_it_wrong( "do_action( 'groups_admin_tabs' )", __( 'This action should not be used directly. Please use the BuddyPress Group Extension API to generate Manage tabs.', 'buddypress' ), '2.2.0' );
+        $subnav_output .= $admin_tabs_backcompat;
+    }
+
+    return $subnav_output;
 }