Changeset 12892

Timestamp:

04/18/2021 10:18:06 AM (3 years ago)

Author:

imath

Message:

Nouveau: improve the way customizable slugs are handled

BuddyPress uses constants such as BP_FRIENDS_SLUG to let advanced users customize component URL slugs. The Nouveau template pack was wrongly checking hardcoded component names at various places into its code, in particular into the following functions and template tags:

• bp_nouveau_current_object()
• bp_nouveau_filter_options()
• bp_nouveau_wrapper()

This commit also introduces a new BP Core function to get the active BP Component objects: bp_core_get_active_components(). The $args argument can be used to filter the active components according to their slugs, names, ids or root slugs. Nouveau uses it to determine the component ID out of its slug and use this component ID instead of slugs to create its needed dynamic selectors, classes and data attributes.

Props mattneil

Fixes #8133

Location:

trunk/src

Files:

• bp-core/bp-core-functions.php (modified) (1 diff)
• bp-members/bp-members-adminbar.php (modified) (3 diffs)
• bp-members/bp-members-template.php (modified) (2 diffs)
• bp-members/classes/class-bp-members-component.php (modified) (1 diff)
• bp-templates/bp-nouveau/buddypress/common/search-and-filters-bar.php (modified) (1 diff)
• bp-templates/bp-nouveau/includes/functions.php (modified) (5 diffs)
• bp-templates/bp-nouveau/includes/template-tags.php (modified) (4 diffs)

trunk/src/bp-core/bp-core-functions.php

@@ -948 +948 @@
      */
     return apply_filters( 'bp_core_get_component_search_query_arg', $query_arg, $component );
+}
+
+/**
+ * Get a list of all active component objects.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args {
+ *     Optional. An array of key => value arguments to match against the component objects.
+ *     Default empty array.
+ *
+ *     @type string $name          Translatable name for the component.
+ *     @type string $id            Unique ID for the component.
+ *     @type string $slug          Unique slug for the component, for use in query strings and URLs.
+ *     @type bool   $has_directory True if the component has a top-level directory. False otherwise.
+ *     @type string $root_slug     Slug used by the component's directory page.
+ * }
+ * @param string $output   Optional. The type of output to return. Accepts 'ids'
+ *                         or 'objects'. Default 'ids'.
+ * @param string $operator Optional. The logical operation to perform. 'or' means only one
+ *                         element from the array needs to match; 'and' means all elements
+ *                         must match. Accepts 'or' or 'and'. Default 'and'.
+ * @return array A list of component ids or objects.
+ */
+function bp_core_get_active_components( $args = array(), $output = 'ids', $operator = 'and' ) {
+    $bp = buddypress();
+
+    $active_components = array_keys( $bp->active_components );
+
+    $xprofile_id = array_search( 'xprofile', $active_components, true );
+    if ( false !== $xprofile_id ) {
+        $active_components[ $xprofile_id ] = 'profile';
+    }
+
+    $components = array();
+    foreach ( $active_components as $id ) {
+        if ( isset( $bp->{$id} ) && $bp->{$id} instanceof BP_Component ) {
+            $components[ $id ] = $bp->{$id};
+        }
+    }
+
+    $components = wp_filter_object_list( $components, $args, $operator );
+
+    if ( 'ids' === $output ) {
+        $components = wp_list_pluck( $components, 'id' );
+    }
+
+    return $components;
 }
 

trunk/src/bp-members/bp-members-adminbar.php

@@ -103 +103 @@
             'id'     => $bp->user_admin_menu_id . '-edit-profile',
             'title'  => __( "Edit Profile", 'buddypress' ),
-            'href'   => bp_get_members_component_link( 'profile', 'edit' )
+            'href'   => bp_get_members_component_link( $bp->profile->id, 'edit' )
         ) );
 
@@ -112 +112 @@
                 'id'     => $bp->user_admin_menu_id . '-change-avatar',
                 'title'  => __( "Edit Profile Photo", 'buddypress' ),
-                'href'   => bp_get_members_component_link( 'profile', 'change-avatar' )
+                'href'   => bp_get_members_component_link( $bp->profile->id, 'change-avatar' )
             ) );
         }
@@ -122 +122 @@
                 'id'     => $bp->user_admin_menu_id . '-change-cover-image',
                 'title'  => __( 'Edit Cover Image', 'buddypress' ),
-                'href'   => bp_get_members_component_link( 'profile', 'change-cover-image' )
+                'href'   => bp_get_members_component_link( $bp->profile->id, 'change-cover-image' )
             ) );
         }

trunk/src/bp-members/bp-members-template.php

@@ -2801 +2801 @@
      */
     function bp_get_members_component_link( $component, $action = '', $query_args = '', $nonce = false ) {
-
         // Must be displayed user.
-        if ( !bp_displayed_user_id() )
+        if ( ! bp_displayed_user_id() ) {
             return;
+        }
 
         $bp = buddypress();
 
+        if ( 'xprofile' === $component ) {
+            $component = 'profile';
+        }
+
         // Append $action to $url if there is no $type.
-        if ( !empty( $action ) )
+        if ( ! empty( $action ) ) {
             $url = bp_displayed_user_domain() . $bp->{$component}->slug . '/' . $action;
-        else
+        } else {
             $url = bp_displayed_user_domain() . $bp->{$component}->slug;
+        }
 
         // Add a slash at the end of our user url.
@@ -2818 +2823 @@
 
         // Add possible query arg.
-        if ( !empty( $query_args ) && is_array( $query_args ) )
+        if ( ! empty( $query_args ) && is_array( $query_args ) ) {
             $url = add_query_arg( $query_args, $url );
+        }
 
         // To nonce, or not to nonce...
-        if ( true === $nonce )
+        if ( true === $nonce ) {
             $url = wp_nonce_url( $url );
-        elseif ( is_string( $nonce ) )
+        } elseif ( is_string( $nonce ) ) {
             $url = wp_nonce_url( $url, $nonce );
+        }
 
         // Return the url, if there is one.
-        if ( !empty( $url ) )
+        if ( ! empty( $url ) ) {
             return $url;
+        }
     }
 

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

@@ -315 +315 @@
         $access       = bp_core_can_edit_settings();
         $slug         = bp_get_profile_slug();
-        $profile_link = bp_get_members_component_link( $slug );
+        $profile_link = bp_get_members_component_link( buddypress()->profile->id );
 
         // Change Avatar.

trunk/src/bp-templates/bp-nouveau/buddypress/common/search-and-filters-bar.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 3.1.0
+ * @version 8.0.0
  */
 ?>
 <div class="subnav-filters filters no-ajax" id="subnav-filters">
 
-    <?php if ( 'friends' !== bp_current_component() ) : ?>
-    <div class="subnav-search clearfix">
+    <?php if ( bp_get_friends_slug() !== bp_current_component() ) : ?>
+        <div class="subnav-search clearfix">
 
-        <?php if ( 'activity' === bp_current_component() ) : ?>
-            <div class="feed"><a href="<?php bp_sitewide_activity_feed_link(); ?>" class="bp-tooltip" data-bp-tooltip="<?php esc_attr_e( 'RSS Feed', 'buddypress' ); ?>"><span class="bp-screen-reader-text"><?php esc_html_e( 'RSS', 'buddypress' ); ?></span></a></div>
-        <?php endif; ?>
+            <?php if ( bp_get_activity_slug() === bp_current_component() ) : ?>
+                <div class="feed"><a href="<?php bp_sitewide_activity_feed_link(); ?>" class="bp-tooltip" data-bp-tooltip="<?php esc_attr_e( 'RSS Feed', 'buddypress' ); ?>"><span class="bp-screen-reader-text"><?php esc_html_e( 'RSS', 'buddypress' ); ?></span></a></div>
+            <?php endif; ?>
 
-        <?php bp_nouveau_search_form(); ?>
+            <?php bp_nouveau_search_form(); ?>
 
-    </div>
+        </div>
     <?php endif; ?>
 
         <?php if ( bp_is_user() && ! bp_is_current_action( 'requests' ) ) : ?>
             <?php bp_get_template_part( 'common/filters/user-screens-filters' ); ?>
-        <?php elseif ( 'groups' === bp_current_component() ) : ?>
+        <?php elseif ( bp_get_groups_slug() === bp_current_component() ) : ?>
             <?php bp_get_template_part( 'common/filters/groups-screens-filters' ); ?>
         <?php else : ?>

trunk/src/bp-templates/bp-nouveau/includes/functions.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 3.1.0
+ * @version 8.0.0
  */
 
@@ -238 +238 @@
  */
 function bp_nouveau_wrapper( $args = array() ) {
- /**
-    * Classes need to be determined & set by component to a certain degree
-    *
-    * Check the component to find a default container_class to add
-    */
-    $current_component_class = bp_current_component() . '-meta';
+    /**
+     * Classes need to be determined & set by component to a certain degree.
+     *
+     * Check the component to find a default container_class based on the component ID to add.
+     * We need to to this because bp_current_component() is using the component slugs which can differ
+     * from the component ID.
+     */
+    $current_component_id = bp_core_get_active_components( array( 'slug' => bp_current_component() ) );
+    if ( $current_component_id && 1 === count( $current_component_id ) ) {
+        $current_component_id = reset( $current_component_id );
+    } else {
+        $current_component_id = bp_current_component();
+    }
+
+    $current_component_class = $current_component_id . '-meta';
 
     if ( bp_is_group_activity() ) {
@@ -256 +265 @@
             'container'         => 'div',
             'container_id'      => '',
-            'container_classes' => array( $generic_class, $current_component_class   ),
+            'container_classes' => array( $generic_class, $current_component_class ),
             'output'            => '',
         ),
@@ -533 +542 @@
 
     if ( empty( $component ) ) {
-        if ( 'directory' === $context || 'user' === $context ) {
-            $component = bp_current_component();
+        if ( 'user' === $context ) {
+            $component = bp_core_get_active_components( array( 'slug' => bp_current_component() ) );
+            $component = reset( $component );
 
             if ( 'friends' === $component ) {
@@ -544 +554 @@
         } elseif ( 'group' === $context && bp_is_group_members() ) {
             $component = 'members';
+        } else {
+            $component = bp_current_component();
         }
     }

trunk/src/bp-templates/bp-nouveau/includes/template-tags.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 7.0.0
+ * @version 8.0.0
  */
 
@@ -2069 +2069 @@
 
     } else {
-        $data_filter = bp_current_component();
+        $component_id = bp_current_component();
+        if ( ! bp_is_directory() ) {
+            $component_id = bp_core_get_active_components( array( 'slug' => $component_id ) );
+            $component_id = reset( $component_id );
+        }
+
+        $data_filter  = $component_id;
+
         if ( 'friends' === $data_filter && bp_is_user_friend_requests() ) {
             $data_filter = 'friend_requests';
@@ -2076 +2083 @@
         $component['members_select']   = 'members-order-select';
         $component['members_order_by'] = 'members-order-by';
-        $component['object']           = bp_current_component();
+        $component['object']           = $component_id;
         $component['data_filter']      = $data_filter;
     }
@@ -2233 +2240 @@
         $output = '';
 
-        if ( 'notifications' === bp_current_component() ) {
+        if ( bp_get_notifications_slug() === bp_current_component() ) {
             $output = bp_nouveau_get_notifications_filters();