Changeset 13136

Timestamp:

11/01/2021 06:13:15 PM (3 years ago)

Author:

imath

Message:

BP Nouveau: improve the Members' directory primary nav's text

The Nouveau template pack will from now on update the Members's directory primary nav's text according to the members displayed list. The 'All Members' text will only be used when filtering this list alphabetically. When using the default filter (last active), this text will now be 'Active Members'. Finally, when filtering the list using the "Newest registered" option, this text will now be 'Newest Members'.

We believe this improvement can avoid the confusion we often make about this nav's count information. To be sure to get the 'All Members' count right, you need to sort the list alphabetically.

Props ketan_chawda

Fixes #8101

Location:

trunk/src/bp-templates/bp-nouveau

Files:

• includes/ajax.php (modified) (6 diffs)
• includes/members/functions.php (modified) (2 diffs)
• js/buddypress-nouveau.js (modified) (1 diff)

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

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 8.0.0
+ * @version 10.0.0
  */
 
@@ -22 +22 @@
     }
 
-    if ( empty( $_POST['object'] ) ) {
-        wp_send_json_error();
-    }
+    $post_vars = bp_parse_args(
+        $_POST,
+        array(
+            'action'   => '',
+            'object'   => '',
+            'scope'    => '',
+            'filter'   => '',
+            'nonce'    => '',
+            'template' => '',
+        )
+    );
 
-    $object = sanitize_title( $_POST['object'] );
+    $object = sanitize_title( $post_vars['object'] );
 
     // Bail if object is not an active component to prevent arbitrary file inclusion.
@@ -34 +42 @@
 
     // Nonce check!
-    if ( empty( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'bp_nouveau_' . $object ) ) {
+    if ( ! $post_vars['nonce'] || ! wp_verify_nonce( $post_vars['nonce'], 'bp_nouveau_' . $object ) ) {
         wp_send_json_error();
     }
@@ -42 +50 @@
     if ( 'activity' === $object ) {
         $scope = '';
-        if ( ! empty( $_POST['scope'] ) ) {
-            $scope = sanitize_text_field( $_POST['scope'] );
+        if ( $post_vars['scope'] ) {
+            $scope = sanitize_text_field( $post_vars['scope'] );
         }
 
@@ -99 +107 @@
 
     // Get the template path based on the 'template' variable via the AJAX request.
-    $template = isset( $_POST['template'] ) ? wp_unslash( $_POST['template'] ) : '';
+    $template = '';
+    if ( $post_vars['template'] ) {
+        $template = wp_unslash( $post_vars['template'] );
+    }
 
     switch ( $template ) {
@@ -141 +152 @@
     ob_end_clean();
 
+    /**
+     * Add additional info to the Ajax response.
+     *
+     * @since 10.0.0
+     *
+     * @param array $value     An associative array with additional information to include in the Ajax response.
+     * @param array $post_vars An associative array containing the Ajax request arguments.
+     */
+    $additional_info = apply_filters( "bp_nouveau_{$object}_ajax_object_template_response", array(), $post_vars );
+    if ( $additional_info ) {
+        // Prevents content overrides.
+        if ( isset( $additional_info['contents'] ) ) {
+            unset( $additional_info['contents'] );
+        }
+
+        $result = array_merge( $result, $additional_info );
+    }
+
     // Locate the object template.
     wp_send_json_success( $result );

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

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 8.0.0
+ * @version 10.0.0
  */
 
@@ -530 +530 @@
     return $nav->get_primary();
 }
+
+/**
+ * Includes additional information about the Members loop Ajax response.
+ *
+ * @since 10.0.0
+ *
+ * @param array $additional_info An associative array with additional information to include in the Ajax response.
+ * @param array $args            The Ajax query arguments.
+ * @return array                 Additional information about the members loop.
+ */
+function bp_nouveau_members_loop_additional_info( $additional_info = array(), $args = array() ) {
+    if ( ! isset( $GLOBALS['members_template'] ) || ! $GLOBALS['members_template'] ) {
+        return $additional_info;
+    }
+
+    $members_template = $GLOBALS['members_template'];
+
+    if ( isset( $members_template->member_count ) && 'all' === $args['scope'] ) {
+        $additional_info['totalItems'] = bp_core_number_format( $members_template->member_count );
+        $additional_info['navLabel']   = esc_html__( 'All Members', 'buddypress' );
+
+        $nav_labels = array(
+            'active' => esc_html__( 'Active Members', 'buddypress' ),
+            'newest' => esc_html__( 'Newest Members', 'buddypress' ),
+        );
+
+        if ( isset( $nav_labels[ $args['filter'] ] ) ) {
+            $additional_info['navLabel'] = $nav_labels[ $args['filter'] ];
+        }
+    }
+
+    return $additional_info;
+}
+add_filter( 'bp_nouveau_members_ajax_object_template_response', 'bp_nouveau_members_loop_additional_info', 10, 2 );

trunk/src/bp-templates/bp-nouveau/js/buddypress-nouveau.js

@@ -307 +307 @@
                 }
 
-                $( self.objectNavParent + ' [data-bp-scope="' + data.scope + '"]' ).removeClass( 'loading' );
+                var selectedObjectNavParent = $( self.objectNavParent + ' [data-bp-scope="' + data.scope + '"]' );
+
+                selectedObjectNavParent.removeClass( 'loading' );
+
+                if ( response.data && response.data.totalItems && response.data.navLabel ) {
+                    selectedObjectNavParent.find( 'a' ).first().html(
+                        response.data.navLabel + ' '
+                    ).append( $( '<span></span>' ).addClass( 'count' ).html( response.data.totalItems ) );
+                }
 
                 if ( 'reset' !== data.method ) {