Changeset 13450 for trunk/src/bp-settings/classes/class-bp-settings-component.php

Timestamp:

04/12/2023 10:12:37 PM (18 months ago)

Author:

imath

Message:

Administration: add a new settings tab to manage slugs customization

Compared to [13442], change the logic of Components user navigation
generation by introducing a BP_Component::register_nav() method to
globalize the nav items early (ie: the registration step) and make them
available for the new settings tab to manage slugs customization.

After a second thought, the BP_Component::setup_nav() should remain the
navigation generation step instead of playing the registration role. This
will maximize backward compatibility & third party plugins wishing their
slugs to be customizable will need to "opt-in" for BP Rewrites using the
BP_Component::register_nav() method.

This first version of the URLs settings tab does not handle slugs
customization yet, its first usage is to make sure all BP Components user
navigation slugs were registered & to put the Accordion UI in place.

Props r-a-y, johnjamesjacoby, boonebgorges

Closes ​https://github.com/buddypress/buddypress/pull/84
See #4954

File:

• trunk/src/bp-settings/classes/class-bp-settings-component.php (modified) (4 diffs)

trunk/src/bp-settings/classes/class-bp-settings-component.php

@@ -120 +120 @@
 
     /**
-     * Set up navigation.
-     *
-     * @since 1.5.0
-     *
-     * @see BP_Component::setup_nav() for a description of arguments.
-     *
-     * @param array $main_nav Optional. See BP_Component::setup_nav() for
+     * Register component navigation.
+     *
+     * @since 12.0.0
+     *
+     * @see `BP_Component::register_nav()` for a description of arguments.
+     *
+     * @param array $main_nav Optional. See `BP_Component::register_nav()` for
      *                        description.
-     * @param array $sub_nav  Optional. See BP_Component::setup_nav() for
+     * @param array $sub_nav  Optional. See `BP_Component::register_nav()` for
      *                        description.
      */
-    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
-
-        // Stop if there is no user displayed or logged in.
-        if ( ! is_user_logged_in() && ! bp_displayed_user_id() ) {
-            return;
-        }
-
-        $access = bp_core_can_edit_settings();
+    public function register_nav( $main_nav = array(), $sub_nav = array() ) {
         $slug   = bp_get_settings_slug();
 
         // Add the settings navigation item.
         $main_nav = array(
-            'name'                    => __( 'Settings', 'buddypress' ),
-            'slug'                    => $slug,
-            'position'                => 100,
-            'show_for_displayed_user' => $access,
-            'screen_function'         => 'bp_settings_screen_general',
-            'default_subnav_slug'     => 'general',
+            'name'                     => __( 'Settings', 'buddypress' ),
+            'slug'                     => $slug,
+            'position'                 => 100,
+            'screen_function'          => 'bp_settings_screen_general',
+            'default_subnav_slug'      => 'general',
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
         );
 
         // Add General Settings nav item.
         $sub_nav[] = array(
-            'name'            => __( 'General', 'buddypress' ),
-            'slug'            => 'general',
-            'parent_slug'     => $slug,
-            'screen_function' => 'bp_settings_screen_general',
-            'position'        => 10,
-            'user_has_access' => $access,
+            'name'                     => __( 'General', 'buddypress' ),
+            'slug'                     => 'general',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_settings_screen_general',
+            'position'                 => 10,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
         );
 
@@ -164 +158 @@
         // retain the old slug and function names for backward compat.
         $sub_nav[] = array(
-            'name'            => __( 'Email', 'buddypress' ),
-            'slug'            => 'notifications',
-            'parent_slug'     => $slug,
-            'screen_function' => 'bp_settings_screen_notification',
-            'position'        => 20,
-            'user_has_access' => $access,
-        );
-
-        // Add Spam Account nav item.
-        if ( bp_current_user_can( 'bp_moderate' ) ) {
-            $sub_nav[] = array(
-                'name'            => __( 'Capabilities', 'buddypress' ),
-                'slug'            => 'capabilities',
-                'parent_slug'     => $slug,
-                'screen_function' => 'bp_settings_screen_capabilities',
-                'position'        => 80,
-                'user_has_access' => ! bp_is_my_profile(),
-            );
-        }
+            'name'                     => __( 'Email', 'buddypress' ),
+            'slug'                     => 'notifications',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_settings_screen_notification',
+            'position'                 => 20,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
+        );
+
+        $sub_nav[] = array(
+            'name'                     => _x( 'Profile Visibility', 'Profile settings sub nav', 'buddypress' ),
+            'slug'                     => 'profile',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_xprofile_screen_settings',
+            'position'                 => 30,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
+        );
+
+        $sub_nav[] = array(
+            'name'                     => __( 'Capabilities', 'buddypress' ),
+            'slug'                     => 'capabilities',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_settings_screen_capabilities',
+            'position'                 => 80,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_settings_show_capability_nav',
+            'generate'                 => bp_current_user_can( 'bp_moderate' ),
+        );
 
         /**
@@ -196 +200 @@
         if ( true === $show_data_page ) {
             $sub_nav[] = array(
-                'name'            => __( 'Export Data', 'buddypress' ),
-                'slug'            => 'data',
-                'parent_slug'     => $slug,
-                'screen_function' => 'bp_settings_screen_data',
-                'position'        => 89,
-                'user_has_access' => $access,
+                'name'                     => __( 'Export Data', 'buddypress' ),
+                'slug'                     => 'data',
+                'parent_slug'              => $slug,
+                'screen_function'          => 'bp_settings_screen_data',
+                'position'                 => 89,
+                'user_has_access'          => false,
+                'user_has_access_callback' => 'bp_core_can_edit_settings',
             );
         }
 
         // Add Delete Account nav item.
-        if ( ( ! bp_disable_account_deletion() && bp_is_my_profile() ) || bp_current_user_can( 'delete_users' ) ) {
-            $sub_nav[] = array(
-                'name'            => __( 'Delete Account', 'buddypress' ),
-                'slug'            => 'delete-account',
-                'parent_slug'     => $slug,
-                'screen_function' => 'bp_settings_screen_delete_account',
-                'position'        => 90,
-                'user_has_access' => ! user_can( bp_displayed_user_id(), 'delete_users' ),
-            );
-        }
-
-        parent::setup_nav( $main_nav, $sub_nav );
+        $sub_nav[] = array(
+            'name'                     => __( 'Delete Account', 'buddypress' ),
+            'slug'                     => 'delete-account',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_settings_screen_delete_account',
+            'position'                 => 90,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_settings_can_delete_self_account',
+            'generate'                 => 'bp_settings_show_delete_account_nav',
+        );
+
+        parent::register_nav( $main_nav, $sub_nav );
     }
 
@@ -225 +230 @@
      * @since 1.5.0
      *
-     * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
+     * @see `BP_Component::setup_admin_bar()` for a description of the $wp_admin_nav
      *      parameter array.
      *
-     * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
+     * @param array $wp_admin_nav See `BP_Component::setup_admin_bar()` for a
      *                            description.
      */