Changeset 9205

Timestamp:

11/29/2014 07:57:25 PM (10 years ago)

Author:

djpaul

Message:

Admin: refactor bp_core_admin_tabs and create a get function.

This is a development aid for contributors experimenting with modifying different parts of BuddyPress screens in side wp-admin.
The nav tabs were defined and templated in the same function, making it hard to modify the output.

File:

• trunk/src/bp-core/admin/bp-core-functions.php (modified) (2 diffs)

trunk/src/bp-core/admin/bp-core-functions.php

@@ -372 +372 @@
  *
  * @since BuddyPress (1.5)
- * @param string $active_tab Name of the tab that is active
+ * @param string $active_tab Name of the tab that is active. Optional.
  */
 function bp_core_admin_tabs( $active_tab = '' ) {
-
-    // Declare local variables
     $tabs_html    = '';
     $idle_class   = 'nav-tab';
     $active_class = 'nav-tab nav-tab-active';
-
-    // Setup core admin tabs
+    $tabs         = apply_filters( 'bp_core_admin_tabs', bp_core_get_admin_tabs( $active_tab ) );
+
+    // Loop through tabs and build navigation
+    foreach ( array_values( $tabs ) as $tab_data ) {
+        $is_current = (bool) ( $tab_data['name'] == $active_tab );
+        $tab_class  = $is_current ? $active_class : $idle_class;
+        $tabs_html .= '<a href="' . esc_url( $tab_data['href'] ) . '" class="' . esc_attr( $tab_class ) . '">' . esc_html( $tab_data['name'] ) . '</a>';
+    }
+
+    echo $tabs_html;
+    do_action( 'bp_admin_tabs' );
+}
+
+/**
+ * Get the data for the tabs in the admin area.
+ *
+ * @since BuddyPress (2.2.0)
+ * @param string $active_tab Name of the tab that is active. Optional.
+ */
+function bp_core_get_admin_tabs( $active_tab = '' ) {
     $tabs = array(
         '0' => array(
@@ -410 +426 @@
     }
 
-    // Allow the tabs to be filtered
-    $tabs = apply_filters( 'bp_core_admin_tabs', $tabs );
-
-    // Loop through tabs and build navigation
-    foreach ( array_values( $tabs ) as $tab_data ) {
-        $is_current = (bool) ( $tab_data['name'] == $active_tab );
-        $tab_class  = $is_current ? $active_class : $idle_class;
-        $tabs_html .= '<a href="' . esc_url( $tab_data['href'] ) . '" class="' . esc_attr( $tab_class ) . '">' . esc_html( $tab_data['name'] ) . '</a>';
-    }
-
-    // Output the tabs
-    echo $tabs_html;
-
-    // Do other fun things
-    do_action( 'bp_admin_tabs' );
+    /**
+     * Filters the tab data used in our wp-admin screens.
+     *
+     * @param array $tabs Tab data.
+     * @since BuddyPress (2.2.0)
+     */
+    return apply_filters( 'bp_core_get_admin_tabs', $tabs );
 }