Changeset 9684

Timestamp:

04/03/2015 01:40:17 PM (10 years ago)

Author:

johnjamesjacoby

Message:

XProfile: Clean up bp_profile_group_tabs():

• Introduce bp_get_profile_group_tabs() for consistency
• Have bp_profile_group_tabs() echo bp_get_profile_group_tabs()
• Remove unused $group_name global
• continue if field-group has no fields to avoid extra code intendation
• Run output of field-group name through bp_get_the_profile_group_name filter for consistency
• Also remove some trailing whitespace from bp-xprofile-template.php

File:

• trunk/src/bp-xprofile/bp-xprofile-template.php (modified) (9 diffs)

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

@@ -20 +20 @@
      */
     public $current_group = -1;
-    
+
     /**
      * The number of groups returned by the paged query.
@@ -29 +29 @@
      */
     public $group_count;
-    
+
     /**
      * Array of groups located by the query.
@@ -38 +38 @@
      */
     public $groups;
-    
+
     /**
      * The group object currently being iterated on.
@@ -56 +56 @@
      */
     public $current_field = -1;
-    
+
     /**
      * The field count.
@@ -65 +65 @@
      */
     public $field_count;
-    
+
     /**
      * Field has data.
@@ -74 +74 @@
      */
     public $field_has_data;
-    
+
     /**
      * The field.
@@ -92 +92 @@
      */
     public $in_the_loop;
-    
+
     /**
      * The user ID.
@@ -921 +921 @@
  * Output the tabs to switch between profile field groups.
  *
+ * @since BuddyPress (1.0.0)
+ *
  * @return string Field group tabs markup.
  */
 function bp_profile_group_tabs() {
-    global $group_name;
-
-    $bp     = buddypress();
-    $groups = bp_profile_get_field_groups();
-
-    if ( empty( $group_name ) )
-        $group_name = bp_profile_group_name(false);
-
-    $tabs = array();
+    echo bp_get_profile_group_tabs();
+
+    /**
+     * Fires at the end of the tab output for switching between profile field
+     * groups. This action is in a strange place for legacy reasons.
+     *
+     * @since BuddyPress (1.0.0)
+     */
+    do_action( 'xprofile_profile_group_tabs' );
+}
+
+/**
+ * Return the XProfile group tabs
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @return string
+ */
+function bp_get_profile_group_tabs() {
+
+    // Get field group data
+    $groups     = bp_profile_get_field_groups();
+    $group_name = bp_get_profile_group_name();
+    $tabs       = array();
+
+    // Loop through field groups and put a tab-lst together
     for ( $i = 0, $count = count( $groups ); $i < $count; ++$i ) {
-        if ( $group_name == $groups[$i]->name )
+
+        // Setup the selected class
+        $selected = '';
+        if ( $group_name === $groups[ $i ]->name ) {
             $selected = ' class="current"';
-        else
-            $selected = '';
-
-        if ( !empty( $groups[$i]->fields ) ) {
-            $link = trailingslashit( bp_displayed_user_domain() . $bp->profile->slug . '/edit/group/' . $groups[$i]->id );
-            $tabs[] = sprintf( '<li %1$s><a href="%2$s">%3$s</a></li>', $selected, $link, esc_html( $groups[$i]->name ) );
-        }
+        }
+
+        // Skip if group has no fields
+        if ( empty( $groups[ $i ]->fields ) ) {
+            continue;
+        }
+
+        // Build the profile field group link
+        $link   = trailingslashit( bp_displayed_user_domain() . buddypress()->profile->slug . '/edit/group/' . $groups[ $i ]->id );
+
+        // Add tab to end of tabs array
+        $tabs[] = sprintf(
+            '<li %1$s><a href="%2$s">%3$s</a></li>',
+            $selected,
+            esc_url( $link ),
+            esc_html( apply_filters( 'bp_get_the_profile_group_name', $groups[ $i ]->name ) )
+        );
     }
 
@@ -955 +987 @@
      */
     $tabs = apply_filters( 'xprofile_filter_profile_group_tabs', $tabs, $groups, $group_name );
-    foreach ( (array) $tabs as $tab )
-        echo $tab;
-
-    /**
-     * Fires at the end of the tab output for switching between profile field groups.
-     *
-     * @since BuddyPress (1.0.0)
-     */
-    do_action( 'xprofile_profile_group_tabs' );
+
+    return join( '', $tabs );
 }