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

Timestamp:

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

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

@@ -149 +149 @@
 
     /**
-     * Set up component 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_friends_slug();
 
-        // Add 'Friends' to the main navigation.
-        $count = friends_get_total_friend_count();
-        $class = ( 0 === $count ) ? 'no-count' : 'count';
-
-        $main_nav_name = sprintf(
-            /* translators: %s: Friend count for the current user */
-            __( 'Friends %s', 'buddypress' ),
-            sprintf(
-                '<span class="%s">%s</span>',
-                esc_attr( $class ),
-                esc_html( $count )
-            )
-        );
-
         $main_nav = array(
-            'name'                => $main_nav_name,
+            'name'                => __( 'Friends', 'buddypress' ),
             'slug'                => $slug,
             'position'            => 60,
@@ -204 +183 @@
 
         $sub_nav[] = array(
-            'name'            => _x( 'Requests', 'Friends screen sub nav', 'buddypress' ),
-            'slug'            => 'requests',
-            'parent_slug'     => $slug,
-            'screen_function' => 'friends_screen_requests',
-            'position'        => 20,
-            'user_has_access' => $access,
-        );
+            'name'                     => _x( 'Requests', 'Friends screen sub nav', 'buddypress' ),
+            'slug'                     => 'requests',
+            'parent_slug'              => $slug,
+            'screen_function'          => 'friends_screen_requests',
+            'position'                 => 20,
+            'user_has_access'          => false,
+            'user_has_access_callback' => 'bp_core_can_edit_settings',
+        );
+
+        parent::register_nav( $main_nav, $sub_nav );
+    }
+
+    /**
+     * Set up component 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
+     *                        description.
+     * @param array $sub_nav  Optional. See `BP_Component::setup_nav()` for
+     *                        description.
+     */
+    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
+        // Only grab count if we're on a user page.
+        if ( bp_is_user() && isset( $this->main_nav['name'] ) ) {
+            // Add 'Friends' to the main navigation.
+            $count                  = friends_get_total_friend_count();
+            $class                  = ( 0 === $count ) ? 'no-count' : 'count';
+            $this->main_nav['name'] = sprintf(
+                /* translators: %s: Friend count for the current user */
+                __( 'Friends %s', 'buddypress' ),
+                sprintf(
+                    '<span class="%s">%s</span>',
+                    esc_attr( $class ),
+                    esc_html( $count )
+                )
+            );
+        }
 
         parent::setup_nav( $main_nav, $sub_nav );