Changeset 12801

Timestamp:

11/20/2020 05:47:32 PM (8 weeks ago)

Author:

imath

Message:

Group Types: improve the bp_group_type_list() template tag

• Make sure to avoid displaying empty links if the Group Types object’s has_directory property is set to false.
• To improve consistency with the Groups directory message informing it is filtered according to a Group Type, use singular Group Type names for the texts used into the list.
• Edit The $r['label'] argument of the bp_get_group_type_list() function so that it accepts an array containing the plural & singular labels to use according to the Group's number of group types it is assigned to.
• Ensure backward compatibility in case developers are still using a string for this $r['label'] argument.

Fixes #8401

Location:

trunk/src

Files:

• bp-groups/bp-groups-template.php (modified) (7 diffs)
• bp-templates/bp-nouveau/buddypress/groups/single/cover-image-header.php (modified) (1 diff)
• bp-templates/bp-nouveau/buddypress/groups/single/group-header.php (modified) (1 diff)

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

@@ -191 +191 @@
         }
 
-        return sprintf( '<a href="%s">%s</a>', esc_url( bp_get_group_type_directory_permalink( $group_type ) ), bp_groups_get_group_type_object( $group_type )->labels['name'] );
+        $group_type_object = bp_groups_get_group_type_object( $group_type );
+
+        if ( ! isset( $group_type_object->labels['name'] ) ) {
+            return '';
+        }
+
+        $group_type_text = $group_type_object->labels['name'];
+        if ( isset( $group_type_object->labels['singular_name'] ) && $group_type_object->labels['singular_name'] ) {
+            $group_type_text = $group_type_object->labels['singular_name'];
+        }
+
+        if ( empty( $group_type_object->has_directory ) ) {
+            return esc_html( $group_type_text );
+        }
+
+        return sprintf(
+            '<a href="%s">%s</a>',
+            esc_url( bp_get_group_type_directory_permalink( $group_type ) ),
+            esc_html( $group_type_text )
+        );
     }
 
@@ -207 +226 @@
      *
      * @since 2.7.0
+     * @since 7.0.0 The `$r['label']` argument now also accept an array containing the
+     *              plural & singular labels to use according to the Group's number of
+     *              group types it is assigned to.
      *
      * @param int $group_id Group ID. Defaults to current group ID if on a group page.
      * @param array|string $r {
      *     Array of parameters. All items are optional.
-     *     @type string $parent_element Element to wrap around the list. Defaults to 'p'.
-     *     @type array  $parent_attr    Element attributes for parent element. Defaults to
-     *                                  array( 'class' => 'bp-group-type-list' ).
-     *     @type string $label          Label to add before the list. Defaults to 'Group Types:'.
-     *     @type string $label_element  Element to wrap around the label. Defaults to 'strong'.
-     *     @type array  $label_attr     Element attributes for label element. Defaults to array().
-     *     @type bool   $show_all       Whether to show all registered group types. Defaults to 'false'. If
-     *                                 'false', only shows group types with the 'show_in_list' parameter set to
-     *                                  true. See bp_groups_register_group_type() for more info.
+     *     @type string       $parent_element Element to wrap around the list. Defaults to 'p'.
+     *     @type array        $parent_attr    Element attributes for parent element. Defaults to
+     *                                        array( 'class' => 'bp-group-type-list' ).
+     *     @type string|array $label          Plural and singular labels to add before the list. Defaults to
+     *                                        array( 'plural' => 'Group Types:', 'singular' => 'Group Type:' ).
+     *     @type string       $label_element  Element to wrap around the label. Defaults to 'strong'.
+     *     @type array        $label_attr     Element attributes for label element. Defaults to array().
+     *     @type bool         $show_all       Whether to show all registered group types. Defaults to 'false'. If
+     *                                       'false', only shows group types with the 'show_in_list' parameter set to
+     *                                        true. See bp_groups_register_group_type() for more info.
      * }
      * @return string
@@ -235 +258 @@
                     'class' => 'bp-group-type-list',
                 ),
-                'label'             => __( 'Group Types:', 'buddypress' ),
+                'label'             => array(),
                 'label_element'     => 'strong',
                 'label_attr'        => array(),
@@ -245 +268 @@
         );
 
+        // Should the label be output?
+        $has_label = ! empty( $r['label'] );
+
+        // Ensure backward compatibility in case developers are still using a string.
+        if ( ! is_array( $r['label'] ) ) {
+            $r['label'] = array(
+                'plural' => __( 'Group Types:', 'buddypress' ),
+            );
+        }
+
+        $labels = wp_parse_args(
+            $r['label'],
+            array(
+                'plural'   => __( 'Group Types:', 'buddypress' ),
+                'singular' => __( 'Group Type:', 'buddypress' ),
+            )
+        );
+
         $retval = '';
 
@@ -257 +298 @@
 
             $before = $after = $label = '';
+            $count  = count( $types );
+
+            if ( 1 === $count ) {
+                $label_text = $labels['singular'];
+            } else {
+                $label_text = $labels['plural'];
+            }
 
             // Render parent element.
@@ -262 +310 @@
                 $parent_elem = new BP_Core_HTML_Element( array(
                     'element' => $r['parent_element'],
-                    'attr'    => $r['parent_attr']
+                    'attr'    => $r['parent_attr'],
                 ) );
 
@@ -275 +323 @@
                     'element'    => $r['label_element'],
                     'attr'       => $r['label_attr'],
-                    'inner_html' => esc_html( $r['label'] )
+                    'inner_html' => esc_html( $label_text ),
                 ) );
                 $label = $label->contents() . ' ';
 
             // No element, just the label.
-            } else {
-                $label = esc_html( $r['label'] );
+            } elseif ( $has_label ) {
+                $label = esc_html( $label_text );
             }
 

trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/cover-image-header.php

@@ -47 +47 @@
                     bp_get_group_id(),
                     array(
-                        'label'        => __( 'Group Types', 'buddypress' ),
+                        'label'        => array(
+                            'plural'   => __( 'Group Types', 'buddypress' ),
+                            'singular' => __( 'Group Type', 'buddypress' ),
+                        ),
                         'list_element' => 'span',
                     )

trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/group-header.php

@@ -44 +44 @@
         bp_get_group_id(),
         array(
-            'label'        => __( 'Group Types', 'buddypress' ),
+            'label'        => array(
+                'plural'   => __( 'Group Types', 'buddypress' ),
+                'singular' => __( 'Group Type', 'buddypress' ),
+            ),
             'list_element' => 'span',
         )