Changeset 13137 for trunk/src/bp-members/classes/class-bp-members-admin.php

Timestamp:

11/06/2021 08:40:08 AM (4 years ago)

Author:

imath

Message:

Use WordPress "site-health" style tabs for BP Admin tabs

The BuddyPress settings and tools screens admin tabs are now using the "site-health" style. As aside from the "site-health" screens, the Privacy screens are also using this tabs' style, we think using this style will improve the way BuddyPress Admin screens integrate inside the WordPress Administration.

We've put a back compatibility process for plugins extending the BuddyPress settings or/and tools screens adding their custom tabs, so that they are automatically converted into these new tabs. Plugin developers are encouraged to progressively update the way they are adding these tabs.

• bp_core_admin_tabbed_screen_header() has been introduced to generate the BuddyPress Admin screens headers using tabs.
• bp_core_get_admin_settings_tabs() has been introduced to return the settings tabs, using the 'bp_core_get_admin_settings_tabs' filter, plugin developers can add their custom tab to the BuddyPress settings screens.
• bp_core_get_admin_settings_tabs() has been introduced to return the settings tabs. Using the 'bp_core_get_admin_settings_tabs' filter, plugin developers can add their custom tabs to the BuddyPress settings screens.
• bp_core_get_admin_tools_tabs() has been introduced to return the tools tabs. Using the 'bp_core_get_admin_tools_tabs' filter, plugin developers can add their custom tabs to the BuddyPress tools screens.
• To make sure BuddyPress generate the inline style to custom tabs, plugin developers need to hook the 'bp_admin_submenu_pages' action which passes by reference an associative array keyed according to the screens to style (settings or tools) and containing the plugin page hookname of their custom screens.

Props oztaser

Fixes #8588

File:

• trunk/src/bp-members/classes/class-bp-members-admin.php (modified) (6 diffs)

trunk/src/bp-members/classes/class-bp-members-admin.php

@@ -150 +150 @@
             $this->capability = 'manage_network_users';
         }
+
+        /*
+         * For consistency with non-Multisite, we add a Tools menu in
+         * the Network Admin as a home for our Tools panel.
+         */
+        if ( is_multisite() && bp_core_do_network_admin() ) {
+            $this->tools_parent = 'network-tools';
+        } else {
+            $this->tools_parent = 'tools.php';
+        }
     }
 
@@ -255 +265 @@
             add_filter( 'pre_get_users', array( $this, 'users_table_filter_by_type' ) );
         }
+
+        // Add the Members invitations submenu page to the tools submenu pages.
+        add_action( 'bp_admin_submenu_pages', array( $this, 'set_submenu_page' ), 10, 1 );
     }
 
@@ -512 +525 @@
         }
 
-        // For consistency with non-Multisite, we add a Tools menu in
-        // the Network Admin as a home for our Tools panel.
-        if ( is_multisite() && bp_core_do_network_admin() ) {
-            $tools_parent = 'network-tools';
-        } else {
-            $tools_parent = 'tools.php';
-        }
-
         $hooks['members_invitations'] = $this->members_invites_page = add_submenu_page(
-            $tools_parent,
+            $this->tools_parent,
             __( 'Manage Invitations',  'buddypress' ),
             __( 'Manage Invitations',  'buddypress' ),
@@ -571 +576 @@
         // Highlight the BuddyPress tools submenu when managing invitations.
         add_action( "admin_head-{$this->members_invites_page}", 'bp_core_modify_admin_menu_highlight' );
+    }
+
+    /**
+     * Include the Members Invitations tab to the Admin tabs needing specific inline styles.
+     *
+     * @since 10.0.0
+     *
+     * @param array $submenu_pages The BP_Admin submenu pages passed by reference.
+     */
+    public function set_submenu_page( &$submenu_pages ) {
+        if ( isset( $submenu_pages['tools'] ) ) {
+            $submenu_pages['tools']['bp-members-invitations'] = get_plugin_page_hookname( 'bp-members-invitations', $this->tools_parent );
+        }
     }
 
@@ -3004 +3022 @@
         );
 
+        bp_core_admin_tabbed_screen_header( __( 'BuddyPress tools', 'buddypress' ), __( 'Manage Invitations', 'buddypress' ), 'tools' );
         ?>
 
-        <div class="wrap">
-            <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 Invitations', 'buddypress' ), 'tools' ); ?></h2>
-
+        <div class="buddypress-body">
             <?php
             if ( $usersearch ) {
@@ -3125 +3139 @@
         );
 
+        bp_core_admin_tabbed_screen_header( __( 'BuddyPress tools', 'buddypress' ), __( 'Manage Invitations', 'buddypress' ), 'tools' );
         ?>
 
-        <div class="wrap">
-            <h1 class="wp-heading-inline"><?php echo esc_html( $header_text ); ?></h1>
-            <hr class="wp-header-end">
+        <div class="buddypress-body">
+            <h2><?php echo esc_html( $header_text ); ?></h2>
 
             <p><?php echo esc_html( $helper_text ); ?></p>