Ticket #8448: 8448.3-tools-tabs.patch

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

@@ -81 +81 @@
         }
 
         // Network Admin > Tools.
-        if ( in_array( $plugin_page, array( 'bp-tools', 'available-tools', 'bp-optouts' ) ) ) {
+        if ( in_array( $plugin_page, array( 'bp-tools', 'available-tools' ) ) ) {
                 $submenu_file = $plugin_page;
         }
+
+        // Keep the BuddyPress tools menu highlighted.
+        if ( 'bp-optouts' === $plugin_page ) {
+                $submenu_file = 'bp-tools';
+        }
 }
 
 /**
@@ -389 +394 @@
  * Output the tabs in the admin area.
  *
  * @since 1.5.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'.
  */
-function bp_core_admin_tabs( $active_tab = '' ) {
+function bp_core_admin_tabs( $active_tab = '', $context = 'settings' ) {
         $tabs_html    = '';
         $idle_class   = 'nav-tab';
         $active_class = 'nav-tab nav-tab-active';
@@ -404 +412 @@
          *
          * @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.
         foreach ( array_values( $tabs ) as $tab_data ) {
@@ -419 +427 @@
          * Fires after the output of tabs for the admin area.
          *
          * @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 );
 }
 
 /**
  * Get the data for the tabs in the admin area.
  *
  * @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' ),
+                        ),
+                        '1' => array(
+                                'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-optouts' ), $tools_page ) ),
+                                'name' => __( 'Manage Opt-outs', 'buddypress' ),
+                        ),
+                );
+        }
 
         /**
          * Filters the tab data used in our wp-admin screens.
          *
          * @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 );
 }
 
 /** Help **********************************************************************/

src/bp-core/admin/bp-core-admin-optouts.php

@@ -315 +315 @@
         ?>
 
         <div class="wrap">
-                <h1 class="wp-heading-inline"><?php _e( 'Nonmember Opt-outs', 'buddypress' ); ?></h1>
+                <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( __( 'Manage Opt-outs', 'buddypress' ), 'tools' ); ?></h2>
 
                 <?php
                 if ( $usersearch ) {
                         $num_results = (int) $bp_optouts_list_table->total_items;
-                        printf( '<span class="subtitle">' . esc_html( _n( 'Opt-out with an email address matching &#8220;%s&#8221;', 'Opt-outs with an email address matching &#8220;%s&#8221;', $num_results, 'buddypress' ) ) . '</span>', esc_html( $usersearch ) );
+                        printf( '<p><span class="subtitle">' . esc_html( _n( 'Opt-out with an email address matching &#8220;%s&#8221;', 'Opt-outs with an email address matching &#8220;%s&#8221;', $num_results, 'buddypress' ) ) . '</span></p>', esc_html( $usersearch ) );
                 }
                 ?>
-                <p class="description"><?php esc_html_e( 'This table shows opt-out requests from people who are not members of this site, but have been contacted via communication from this site, and wish to receive no further communications.', 'buddypress' ); ?></p>
-
-                <hr class="wp-header-end">
+                <p><?php esc_html_e( 'This table shows opt-out requests from people who are not members of this site, but have been contacted via communication from this site, and wish to receive no further communications.', 'buddypress' ); ?></p>
 
                 <?php // Display each opt-out on its own row. ?>
                 <?php $bp_optouts_list_table->views(); ?>
@@ -379 +380 @@
         // Check optout IDs and set up strings.
         switch ( $action ) {
                 case 'delete' :
-                        $header_text = __( 'Delete optouts', 'buddypress' );
                         if ( 1 == count( $optouts ) ) {
                                 $helper_text = __( 'You are about to delete the following opt-out request:', 'buddypress' );
                         } else {
@@ -415 +415 @@
         ?>
 
         <div class="wrap">
-                <h1 class="wp-heading-inline"><?php echo esc_html( $header_text ); ?></h1>
+                <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( __( 'Manage Opt-outs', 'buddypress' ), 'tools' ); ?></h2>
+
                 <p><?php echo esc_html( $helper_text ); ?></p>
 
                 <ol class="bp-optouts-list">

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>
                 <p><?php esc_html_e( 'Occasionally these relationships become out of sync, most often after an import, update, or migration.', 'buddypress' ); ?></p>
                 <p><?php esc_html_e( 'Use the tools below to manually recalculate these relationships.', 'buddypress' ); ?>
@@ -541 +543 @@
         $page = bp_core_do_network_admin() ? 'admin.php' : 'tools.php' ;
         $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>
+                        <dt><?php esc_html_e( 'Manage Opt-outs', 'buddypress' ) ?></dt>
+                        <dd>
+                                <?php esc_html_e( 'Some introduction text to replace with something more meaningful.', 'buddypress' ); ?>
+                                <?php
+                                $url = add_query_arg( 'page', 'bp-optouts', bp_get_admin_url( $page ) );
+                                printf(
+                                        /* translators: %s: the link to the BuddyPress Nonmember Opt-outs */
+                                        esc_html_x( 'Checkout %s to eventually do something great!', 'buddypress opt-outs intro', 'buddypress' ),
+                                        '<a href="' . esc_url( $url ) . '">' . esc_html__( 'Nonmember Opt-outs', 'buddypress' ) . '</a>'
+                                );
+                                ?>
+                        </dd>
+                </dl>
         </div>
         <?php
 }

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

@@ -306 +306 @@
         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;
+}
+
 /*
  * 2.4 Tooltips
  */

src/bp-core/classes/class-bp-admin.php

@@ -544 +544 @@
                 // About and Credits pages.
                 remove_submenu_page( 'index.php', 'bp-about'   );
                 remove_submenu_page( 'index.php', 'bp-credits' );
+
+                // Nonmembers Opt-outs page.
+                remove_submenu_page( 'tools.php', 'bp-optouts' );
         }
 
         /**