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

Timestamp:

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

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

@@ -423 +423 @@
      *
      * @since 6.0.0
+     * @deprecated 12.0.0
      *
      * @return array The Avatar and Cover image subnavs.
      */
     public function get_avatar_cover_image_subnavs() {
-        $subnavs = array();
-
-        $access = bp_core_can_edit_settings();
-        $slug   = bp_get_profile_slug();
-
-        // Change Avatar.
-        if ( buddypress()->avatar->show_avatars ) {
-            $subnavs[] = array(
-                'name'            => _x( 'Change Profile Photo', 'Profile header sub menu', 'buddypress' ),
-                'slug'            => 'change-avatar',
-                'parent_slug'     => $slug,
-                'screen_function' => 'bp_members_screen_change_avatar',
-                'position'        => 30,
-                'user_has_access' => $access
-            );
-        }
-
-        // Change Cover image.
-        if ( bp_displayed_user_use_cover_image_header() ) {
-            $subnavs[] = array(
-                'name'            => _x( 'Change Cover Image', 'Profile header sub menu', 'buddypress' ),
-                'slug'            => 'change-cover-image',
-                'parent_slug'     => $slug,
-                'screen_function' => 'bp_members_screen_change_cover_image',
-                'position'        => 40,
-                'user_has_access' => $access
-            );
-        }
-
-        return $subnavs;
-    }
-
-    /**
-     * Set up fall-back component navigation if XProfile is inactive.
-     *
-     * @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
+        _deprecated_function( __METHOD__, '12.0.0' );
+    }
+
+    /**
+     * 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() ) {
-
-        // Don't set up navigation if there's no member.
-        if ( ! is_user_logged_in() && ! bp_is_user() ) {
-            return;
-        }
-
-        $is_xprofile_active = bp_is_active( 'xprofile' );
-
-        // Bail if XProfile component is active and there's no custom front page for the user.
-        if ( ! bp_displayed_user_has_front_template() && $is_xprofile_active ) {
-            add_action( 'bp_xprofile_setup_nav', array( $this, 'setup_xprofile_nav' ) );
-            return;
-        }
-
+    public function register_nav( $main_nav = array(), $sub_nav = array() ) {
         // Set slug to profile in case the xProfile component is not active
         $slug = bp_get_profile_slug();
 
-        // Defaults to empty navs
-        $this->main_nav = array();
-        $this->sub_nav  = array();
-
-        if ( ! $is_xprofile_active ) {
-            $this->main_nav = array(
-                'name'                => _x( 'Profile', 'Member profile main navigation', 'buddypress' ),
-                'slug'                => $slug,
-                'position'            => 20,
-                'screen_function'     => 'bp_members_screen_display_profile',
-                'default_subnav_slug' => 'public',
-                'item_css_id'         => buddypress()->profile->id
-            );
-
-        /**
-         * The xProfile component is active.
-         *
-         * We need to make sure the Change Avatar and Change Cover Image subnavs are
-         * added just like it was the case before.
-         */
-        } else {
-            add_action( 'bp_xprofile_setup_nav', array( $this, 'setup_xprofile_nav' ) );
-        }
-
-        /**
-         * Setup the subnav items for the member profile.
-         *
-         * This is required in case there's a custom front or in case the xprofile component
-         * is not active.
-         */
-        $this->sub_nav = array(
+        $main_nav = array(
+            'name'                => _x( 'Profile', 'Member profile main navigation', 'buddypress' ),
+            'slug'                => $slug,
+            'position'            => 20,
+            'screen_function'     => 'bp_members_screen_display_profile',
+            'default_subnav_slug' => 'public',
+            'item_css_id'         => buddypress()->profile->id,
+            'generate'            => ! bp_is_active( 'xprofile' ),
+        );
+
+        $sub_nav[] = array(
             'name'            => _x( 'View', 'Member profile view', 'buddypress' ),
             'slug'            => 'public',
             'parent_slug'     => $slug,
             'screen_function' => 'bp_members_screen_display_profile',
-            'position'        => 10
-        );
-
-        /**
-         * If there's a front template the members component nav
-         * will be there to display the user's front page.
-         */
-        if ( bp_displayed_user_has_front_template() ) {
-            $main_nav = array(
-                'name'                => _x( 'Home', 'Member Home page', 'buddypress' ),
-                'slug'                => 'front',
-                'position'            => 5,
-                'screen_function'     => 'bp_members_screen_display_profile',
-                'default_subnav_slug' => 'public',
-            );
-
-            // We need a dummy subnav for the front page to load.
-            $front_subnav = $this->sub_nav;
-            $front_subnav['parent_slug'] = 'front';
-
-            // Set the subnav
-            $sub_nav[] = $front_subnav;
-
-            /**
-             * If the profile component is not active, we need to create a new
-             * nav to display the WordPress profile.
-             */
-            if ( ! $is_xprofile_active ) {
-                add_action( 'bp_members_setup_nav', array( $this, 'setup_profile_nav' ) );
-            }
-
-        /**
-         * If there's no front template and xProfile is not active, the members
-         * component nav will be there to display the WordPress profile
-         */
-        } else {
-            $main_nav  = $this->main_nav;
-            $sub_nav   = array( $this->sub_nav );
-
-            if ( ! $is_xprofile_active ) {
-                $sub_nav = array_merge( $sub_nav, $this->get_avatar_cover_image_subnavs() );
-            }
-        }
-
-        parent::setup_nav( $main_nav, $sub_nav );
+            'position'        => 10,
+            'generate'        => ! bp_is_active( 'xprofile' ),
+        );
+
+        $sub_nav[] = array(
+            'name'                     => _x( 'Change Profile Photo', 'Profile header sub menu', 'buddypress' ),
+            'slug'                     => 'change-avatar',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_members_screen_change_avatar',
+            'position'                 => 30,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
+            'generate'                 => buddypress()->avatar->show_avatars,
+        );
+
+        $sub_nav[] = array(
+            'name'                     => _x( 'Change Cover Image', 'Profile header sub menu', 'buddypress' ),
+            'slug'                     => 'change-cover-image',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'bp_members_screen_change_cover_image',
+            'position'                 => 40,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
+            'generate'                 => bp_displayed_user_use_cover_image_header(),
+        );
+
+        parent::register_nav( $main_nav, $sub_nav );
     }
 
@@ -577 +497 @@
      *
      * @since 2.6.0
+     * @deprecated 12.0.0
      */
     public function setup_profile_nav() {
-        if ( empty( $this->main_nav ) || empty( $this->sub_nav ) ) {
-            return;
-        }
-
-        // Add the main nav
-        bp_core_new_nav_item( $this->main_nav, 'members' );
-
-        // Add the sub nav item.
-        bp_core_new_subnav_item( $this->sub_nav, 'members' );
-
-        // Get the Avatar and cover image subnavs.
-        $this->setup_xprofile_nav();
+        _deprecated_function( __METHOD__, '12.0.0' );
     }
 
@@ -597 +507 @@
      *
      * @since 6.0.0
+     * @deprecated 12.0.0
      */
     public function setup_xprofile_nav() {
-        // Get the Avatar and cover image subnavs.
-        $items = $this->get_avatar_cover_image_subnavs();
-
-        foreach ( $items as $item ) {
-            bp_core_new_subnav_item( $item, 'members' );
-        }
+        _deprecated_function( __METHOD__, '12.0.0' );
     }