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

Timestamp:

04/12/2023 10:12:37 PM (22 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-xprofile/classes/class-bp-xprofile-component.php (modified) (3 diffs)

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

@@ -221 +221 @@
 
     /**
-     * Set up navigation.
-     *
-     * @since 1.5.0
-     *
-     * @param array $main_nav Array of main nav items to set up.
-     * @param array $sub_nav  Array of sub nav items to set up.
-     */
-    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();
-        $slug   = bp_get_profile_slug();
+     * Register component navigation.
+     *
+     * @since 12.0.0
+     *
+     * @param array $main_nav See `BP_Component::register_nav()` for details.
+     * @param array $sub_nav  See `BP_Component::register_nav()` for details.
+     */
+    public function register_nav( $main_nav = array(), $sub_nav = array() ) {
+        $slug = bp_get_profile_slug();
 
         // Add 'Profile' to the main navigation.
@@ -259 +252 @@
         // Edit Profile.
         $sub_nav[] = array(
-            'name'            => _x( 'Edit','Profile header sub menu', 'buddypress' ),
-            'slug'            => 'edit',
-            'parent_slug'     => $slug,
-            'screen_function' => 'xprofile_screen_edit_profile',
-            'position'        => 20,
-            'user_has_access' => $access,
-        );
-
-        // The Settings > Profile nav item can only be set up after
-        // the Settings component has run its own nav routine.
-        add_action( 'bp_settings_setup_nav', array( $this, 'setup_settings_nav' ) );
-
-        parent::setup_nav( $main_nav, $sub_nav );
+            'name'                     => _x( 'Edit','Profile header sub menu', 'buddypress' ),
+            'slug'                     => 'edit',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'xprofile_screen_edit_profile',
+            'position'                 => 20,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
+        );
+
+        parent::register_nav( $main_nav, $sub_nav );
     }
 
@@ -281 +271 @@
      *
      * @since 2.1.0
+     * @deprecated 12.0.0
      */
     public function setup_settings_nav() {
-        if ( ! bp_is_active( 'settings' ) ) {
-            return;
-        }
-
-        // Stop if there is no user displayed or logged in.
-        if ( ! is_user_logged_in() && ! bp_displayed_user_id() ) {
-            return;
-        }
-
-        // Get the settings slug.
-        $settings_slug = bp_get_settings_slug();
-
-        bp_core_new_subnav_item( array(
-            'name'            => _x( 'Profile Visibility', 'Profile settings sub nav', 'buddypress' ),
-            'slug'            => 'profile',
-            'parent_slug'     => $settings_slug,
-            'screen_function' => 'bp_xprofile_screen_settings',
-            'position'        => 30,
-            'user_has_access' => bp_core_can_edit_settings(),
-        ), 'members' );
+        _deprecated_function( __METHOD__, '12.0.0' );
     }