Changeset 13275

Timestamp:

04/29/2022 08:00:56 PM (3 years ago)

Author:

imath

Message:

BP Nouveau: support custom slugs in Messages UI

The Messages UI Backbone Router is no more using hardcoded slugs to define its routes. It's now possible to use customized slugs for the BP Messages component and still enjoy this UI.

Fixes #8691 (branch 10.0)

Location:

branches/10.0/src

Files:

• bp-messages/classes/class-bp-messages-component.php (modified) (1 diff)
• bp-templates/bp-nouveau/includes/messages/functions.php (modified) (4 diffs)
• bp-templates/bp-nouveau/js/buddypress-messages.js (modified) (7 diffs)

branches/10.0/src/bp-messages/classes/class-bp-messages-component.php

@@ -269 +269 @@
         );
 
-        // Show certain screens only if the current user is the displayed user.
-        if ( bp_is_my_profile() ) {
-
-            // Show "Compose" on the logged-in user's profile only.
-            $sub_nav[] = array(
-                'name'            => __( 'Compose', 'buddypress' ),
-                'slug'            => 'compose',
-                'parent_url'      => $messages_link,
-                'parent_slug'     => $slug,
-                'screen_function' => 'messages_screen_compose',
-                'position'        => 30,
-                'user_has_access' => $access
-            );
-
-            /*
-             * Show "Notices" on the logged-in user's profile only
-             * and then only if the user can create notices.
-             */
-            if ( bp_current_user_can( 'bp_moderate' ) ) {
-                $sub_nav[] = array(
-                    'name'            => __( 'Notices', 'buddypress' ),
-                    'slug'            => 'notices',
-                    'parent_url'      => $messages_link,
-                    'parent_slug'     => $slug,
-                    'screen_function' => 'messages_screen_notices',
-                    'position'        => 90,
-                    'user_has_access' => true
-                );
-            }
-        }
+        // Show "Compose" on the logged-in user's profile only.
+        $sub_nav[] = array(
+            'name'            => __( 'Compose', 'buddypress' ),
+            'slug'            => 'compose',
+            'parent_url'      => $messages_link,
+            'parent_slug'     => $slug,
+            'screen_function' => 'messages_screen_compose',
+            'position'        => 30,
+            'user_has_access' => bp_is_my_profile(),
+        );
+
+        // Show "Notices" to community admins only.
+        $sub_nav[] = array(
+            'name'            => __( 'Notices', 'buddypress' ),
+            'slug'            => 'notices',
+            'parent_url'      => $messages_link,
+            'parent_slug'     => $slug,
+            'screen_function' => 'messages_screen_notices',
+            'position'        => 90,
+            'user_has_access' => bp_current_user_can( 'bp_moderate' )
+        );
 
         parent::setup_nav( $main_nav, $sub_nav );

branches/10.0/src/bp-templates/bp-nouveau/includes/messages/functions.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 10.0.0
+ * @version 10.3.0
  */
 
@@ -91 +91 @@
     }
 
+    $bp   = buddypress();
+    $slug = bp_nouveau_get_component_slug( 'messages' );
+
+    // Use the primary nav to get potential custom slugs.
+    $primary_nav = $bp->members->nav->get( $slug );
+    if ( isset( $primary_nav->link ) && $primary_nav->link ) {
+        $root_url = $primary_nav->link;
+
+        // Make sure to use the displayed user domain.
+        if ( bp_loggedin_user_domain() ) {
+            $root_url = str_replace( bp_loggedin_user_domain(), bp_displayed_user_domain(), $root_url );
+        }
+    } else {
+        $root_url = trailingslashit( bp_displayed_user_domain() . $slug );
+    }
+
+    // Build default routes list.
+    $routes = array(
+        'inbox'   => 'inbox',
+        'sentbox' => 'sentbox',
+        'compose' => 'compose',
+    );
+
+    if ( bp_is_active( 'messages', 'star' ) ) {
+        $routes['starred'] = 'starred';
+    }
+
+    // Use the secondary nav to get potential custom slugs.
+    $secondary_nav = $bp->members->nav->get_secondary( array( 'parent_slug' => $slug ), false );
+
+    // Resets the routes list using link slugs.
+    if ( $secondary_nav ) {
+        foreach ( $secondary_nav as $subnav_item ) {
+            $routes[ $subnav_item->slug ] = trim( str_replace( $root_url, '', $subnav_item->link ), '/' );
+
+            if ( ! $routes[ $subnav_item->slug ] ) {
+                $routes[ $subnav_item->slug ] = $subnav_item->slug;
+            }
+        }
+    }
+
     $params['messages'] = array(
-        'errors' => array(
+        'errors'            => array(
             'send_to'         => __( 'Please add at least one recipient.', 'buddypress' ),
             'subject'         => __( 'Please add a subject to your message.', 'buddypress' ),
             'message_content' => __( 'Please add some content to your message.', 'buddypress' ),
         ),
-        'nonces' => array(
+        'nonces'            => array(
             'send' => wp_create_nonce( 'messages_send_message' ),
         ),
-        'loading'       => __( 'Loading messages. Please wait.', 'buddypress' ),
-        'doingAction'   => array(
+        'loading'           => __( 'Loading messages. Please wait.', 'buddypress' ),
+        'doingAction'       => array(
             'read'   => __( 'Marking messages as read. Please wait.', 'buddypress' ),
             'unread' => __( 'Marking messages as unread. Please wait.', 'buddypress' ),
@@ -108 +149 @@
             'unstar' => __( 'Unstarring messages. Please wait.', 'buddypress' ),
         ),
-        'bulk_actions'  => bp_nouveau_messages_get_bulk_actions(),
-        'howto'         => __( 'Click on the message title to preview it in the Active conversation box below.', 'buddypress' ),
-        'howtoBulk'     => __( 'Use the select box to define your bulk action and click on the ✓ button to apply.', 'buddypress' ),
-        'toOthers'      => array(
+        'bulk_actions'      => bp_nouveau_messages_get_bulk_actions(),
+        'howto'             => __( 'Click on the message title to preview it in the Active conversation box below.', 'buddypress' ),
+        'howtoBulk'         => __( 'Use the select box to define your bulk action and click on the ✓ button to apply.', 'buddypress' ),
+        'toOthers'          => array(
             'one'  => __( '(and 1 other)', 'buddypress' ),
 
@@ -117 +158 @@
             'more' => __( '(and %d others)', 'buddypress' ),
         ),
-        'rootUrl' => parse_url( trailingslashit( bp_displayed_user_domain() . bp_nouveau_get_component_slug( 'messages' ) ), PHP_URL_PATH ),
+        'rootUrl'           => parse_url( $root_url, PHP_URL_PATH ),
+        'supportedRoutes'   => $routes,
     );
 

branches/10.0/src/bp-templates/bp-nouveau/js/buddypress-messages.js

@@ -2 +2 @@
 /* jshint devel: true */
 /* @since 3.0.0 */
-/* @version 10.2.0 */
+/* @version 10.3.0 */
 window.wp = window.wp || {};
 window.bp = window.bp || {};
@@ -37 +37 @@
             this.box      = 'inbox';
 
+            // Set up supported routes.
+            this.supportedRoutes = BP_Nouveau.messages.supportedRoutes;
+
             this.setupNav();
 
@@ -54 +57 @@
             $( '#subnav a' ).on( 'click', function( event ) {
                 var view_id = $( event.target ).prop( 'id' ),
-                    supportedView = [ 'inbox', 'starred', 'sentbox', 'compose' ];
+                    supportedView = _.keys( self.supportedRoutes );
 
                 if ( -1 === _.indexOf( supportedView, view_id ) || 'unsupported' === self.box ) {
@@ -79 +82 @@
 
                         // Navigate back to current box.
-                        self.router.navigate( self.box + '/', { trigger: true } );
+                        self.router.navigate( self.supportedRoutes[ self.box ] + '/', { trigger: true } );
 
                     // Otherwise load it.
                     } else {
-                        self.router.navigate( 'compose/', { trigger: true } );
+                        self.router.navigate( self.supportedRoutes.compose + '/', { trigger: true } );
                     }
 
@@ -92 +95 @@
                         self.clearViews();
 
-                        self.router.navigate( view_id + '/', { trigger: true } );
+                        self.router.navigate( self.supportedRoutes[ view_id ] + '/', { trigger: true } );
                     }
                 }
@@ -677 +680 @@
                 bp.Nouveau.Messages.views.remove( { id: 'compose', view: form } );
 
-                bp.Nouveau.Messages.router.navigate( 'sentbox/', { trigger: true } );
+                bp.Nouveau.Messages.router.navigate( bp.Nouveau.Messages.supportedRoutes.sentbox + '/', { trigger: true } );
             } ).fail( function( response ) {
                 if ( response.feedback ) {
@@ -1401 +1404 @@
     bp.Nouveau.Messages.Router = Backbone.Router.extend( {
         routes: {
-            'compose/'    : 'composeMessage',
             'view/:id/'   : 'viewMessage',
-            'sentbox/'    : 'sentboxView',
-            'starred/'    : 'starredView',
-            'inbox/'      : 'inboxView',
             ''            : 'inboxView',
             '*unSupported': 'unSupported'
+        },
+
+        initialize: function() {
+            var self = this;
+
+            _.each( BP_Nouveau.messages.supportedRoutes, function( route, slug ) {
+                self.route( route + '/', slug + 'Route', function() {
+                    if ( 'compose' === slug ) {
+                        self.composeMessage();
+                    } else if ( 'sentbox' === slug ) {
+                        self.sentboxView();
+                    } else if ( 'starred' === slug ) {
+                        self.starredView();
+                    } else if ( 'inbox' === slug ) {
+                        self.inboxView();
+                    }
+                } );
+            } );
         },