Changeset 12897

Timestamp:

04/20/2021 04:02:22 PM (3 months ago)

Author:

dcavins

Message:

BP Admin Tools: Add tab interface to support additional screens.

Expand the BP Tools screen to use a tabbed interface
so that multiple tools screens can be grouped in a
single Tools > BuddyPress menu item.

Props imath.

See #8448.

Location:

trunk/src/bp-core/admin

Files:

• bp-core-admin-functions.php (modified) (5 diffs)
• bp-core-admin-tools.php (modified) (2 diffs)
• css/common.css (modified) (1 diff)

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

@@ -390 +390 @@
  *
  * @since 1.5.0
+ * @since 8.0.0 Adds the `$context` parameter.
  *
  * @param string $active_tab Name of the tab that is active. Optional.
- */
-function bp_core_admin_tabs( $active_tab = '' ) {
+ * @param string $context    The context of use for the tabs. Defaults to 'settings'.
+ *                           Possible values are 'settings' & 'tools'.
+ */
+function bp_core_admin_tabs( $active_tab = '', $context = 'settings' ) {
     $tabs_html    = '';
     $idle_class   = 'nav-tab';
@@ -405 +408 @@
      * @param array $value Array of tabs to output to the admin area.
      */
-    $tabs = apply_filters( 'bp_core_admin_tabs', bp_core_get_admin_tabs( $active_tab ) );
+    $tabs = apply_filters( 'bp_core_admin_tabs', bp_core_get_admin_tabs( $active_tab, $context ) );
 
     // Loop through tabs and build navigation.
@@ -420 +423 @@
      *
      * @since 1.5.0
+     * @since 8.0.0 Adds the `$context` parameter.
+     *
+     * @param string $context The context of use for the tabs.
      */
-    do_action( 'bp_admin_tabs' );
+    do_action( 'bp_admin_tabs', $context );
 }
 
@@ -428 +434 @@
  *
  * @since 2.2.0
+ * @since 8.0.0 Adds the `$context` parameter.
  *
  * @param string $active_tab Name of the tab that is active. Optional.
+ * @param string $context    The context of use for the tabs. Defaults to 'settings'.
+ *                           Possible values are 'settings' & 'tools'.
  * @return string
  */
-function bp_core_get_admin_tabs( $active_tab = '' ) {
-    $tabs = array(
-        '0' => array(
-            'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-components' ), 'admin.php' ) ),
-            'name' => __( 'Components', 'buddypress' ),
-        ),
-        '2' => array(
-            'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-settings' ), 'admin.php' ) ),
-            'name' => __( 'Options', 'buddypress' ),
-        ),
-        '1' => array(
-            'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-page-settings' ), 'admin.php' ) ),
-            'name' => __( 'Pages', 'buddypress' ),
-        ),
-        '3' => array(
-            'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-credits' ), 'admin.php' ) ),
-            'name' => __( 'Credits', 'buddypress' ),
-        ),
-    );
+function bp_core_get_admin_tabs( $active_tab = '', $context = 'settings' ) {
+    $tabs = array();
+
+    if ( 'settings' === $context ) {
+        $tabs = array(
+            '0' => array(
+                'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-components' ), 'admin.php' ) ),
+                'name' => __( 'Components', 'buddypress' ),
+            ),
+            '2' => array(
+                'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-settings' ), 'admin.php' ) ),
+                'name' => __( 'Options', 'buddypress' ),
+            ),
+            '1' => array(
+                'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-page-settings' ), 'admin.php' ) ),
+                'name' => __( 'Pages', 'buddypress' ),
+            ),
+            '3' => array(
+                'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-credits' ), 'admin.php' ) ),
+                'name' => __( 'Credits', 'buddypress' ),
+            ),
+        );
+    } elseif ( 'tools' === $context ) {
+        $tools_page = 'tools.php';
+        if ( bp_core_do_network_admin() ) {
+            $tools_page = 'admin.php';
+        }
+
+        $tabs = array(
+            '0' => array(
+                'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-tools' ), $tools_page ) ),
+                'name' => __( 'Repair', 'buddypress' ),
+            ),
+        );
+    }
 
     /**
@@ -456 +481 @@
      *
      * @since 2.2.0
+     * @since 8.0.0 Adds the `$context` parameter.
      *
-     * @param array $tabs Tab data.
+     * @param array  $tabs    Tab data.
+     * @param string $context The context of use for the tabs.
      */
-    return apply_filters( 'bp_core_get_admin_tabs', $tabs );
+    return apply_filters( 'bp_core_get_admin_tabs', $tabs, $context );
 }
 

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

@@ -22 +22 @@
         <h1 class="wp-heading-inline"><?php esc_html_e( 'BuddyPress Tools', 'buddypress' ) ?></h1>
         <hr class="wp-header-end">
+
+        <h2 class="nav-tab-wrapper"><?php bp_core_admin_tabs( __( 'Repair', 'buddypress' ), 'tools' ); ?></h2>
 
         <p><?php esc_html_e( 'BuddyPress keeps track of various relationships between members, groups, and activity items.', 'buddypress' ); ?></p>
@@ -542 +544 @@
     $url  = add_query_arg( $query_arg, bp_get_admin_url( $page ) );
     ?>
-    <div class="card tool-box">
+    <div class="card tool-box bp-tools">
         <h2><?php esc_html_e( 'BuddyPress Tools', 'buddypress' ) ?></h2>
-        <p>
-            <?php esc_html_e( 'BuddyPress keeps track of various relationships between users, groups, and activity items. Occasionally these relationships become out of sync, most often after an import, update, or migration.', 'buddypress' ); ?>
-            <?php
-            printf(
-                /* translators: %s: the link to the BuddyPress repair tools */
-                esc_html_x( 'Use the %s to repair these relationships.', 'buddypress tools intro', 'buddypress' ),
-                '<a href="' . esc_url( $url ) . '">' . esc_html__( 'BuddyPress Tools', 'buddypress' ) . '</a>'
-            );
-            ?>
-        </p>
+
+        <dl>
+            <dt><?php esc_html_e( 'Repair Tools', 'buddypress' ) ?></dt>
+            <dd>
+                <?php esc_html_e( 'BuddyPress keeps track of various relationships between users, groups, and activity items. Occasionally these relationships become out of sync, most often after an import, update, or migration.', 'buddypress' ); ?>
+                <?php
+                printf(
+                    /* translators: %s: the link to the BuddyPress repair tools */
+                    esc_html_x( 'Use the %s to repair these relationships.', 'buddypress tools intro', 'buddypress' ),
+                    '<a href="' . esc_url( $url ) . '">' . esc_html__( 'BuddyPress Repair Tools', 'buddypress' ) . '</a>'
+                );
+                ?>
+            </dd>
+        </dl>
     </div>
     <?php

trunk/src/bp-core/admin/css/common.css

@@ -305 +305 @@
 #adminmenu .toplevel_page_network-tools div.wp-menu-image:before {
     content: "";
+}
+
+body.tools-php .bp-tools dt {
+    font-size: 1.1em;
+    color: #646970;
+    font-weight: 600;
+    margin: 1em 0 0.5em 0;
+}
+
+body.tools-php .bp-tools dd {
+    margin: 0;
 }