Changeset 8751

Timestamp:

08/03/2014 02:17:58 AM (10 years ago)

Author:

johnjamesjacoby

Message:

Clean up bp_get_group_avatar():

• Remove $bp global
• Use bp_parse_args()
• Code format tidying
• Pass $r through filter
• Add documentation

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (2 diffs)

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

@@ -550 +550 @@
     }
 
+/**
+ * Output the group avatar while in the groups loop.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param array $args {@see bp_core_fetch_avatar()}
+ */
 function bp_group_avatar( $args = '' ) {
     echo bp_get_group_avatar( $args );
 }
+    /**
+     * Return the group avatar while in the groups loop.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param array $args {@see bp_core_fetch_avatar()}
+     */
     function bp_get_group_avatar( $args = '' ) {
-        global $bp, $groups_template;
-
+        global $groups_template;
+
+        // Bail if avatars are turned off
+        // @todo Should we maybe still filter this?
         if ( ! buddypress()->avatar->show_avatars ) {
             return false;
         }
 
-        $defaults = array(
+        // Parse the arguments
+        $r = bp_parse_args( $args, array(
             'type'   => 'full',
             'width'  => false,
@@ -567 +584 @@
             'id'     => false,
             'alt'    => sprintf( __( 'Group logo of %s', 'buddypress' ), $groups_template->group->name )
-        );
-
-        $r = wp_parse_args( $args, $defaults );
-        extract( $r, EXTR_SKIP );
-
-        /* Fetch the avatar from the folder, if not provide backwards compat. */
-        if ( !$avatar = bp_core_fetch_avatar( array( 'item_id' => $groups_template->group->id, 'object' => 'group', 'type' => $type, 'avatar_dir' => 'group-avatars', 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'title' => $groups_template->group->name, 'alt' => $alt ) ) )
+        ) );
+
+        // Fetch the avatar from the folder
+        $avatar = bp_core_fetch_avatar( array(
+            'item_id'    => $groups_template->group->id,
+            'title'      => $groups_template->group->name,
+            'avatar_dir' => 'group-avatars',
+            'object'     => 'group',
+            'type'       => $r['type'],
+            'alt'        => $r['alt'],
+            'css_id'     => $r['id'],
+            'class'      => $r['class'],
+            'width'      => $r['width'],
+            'height'     => $r['height']
+        ) );
+
+        // If No avatar found, provide some backwards compatibility
+        if ( empty( $avatar ) ) {
             $avatar = '<img src="' . esc_url( $groups_template->group->avatar_thumb ) . '" class="avatar" alt="' . esc_attr( $groups_template->group->name ) . '" />';
-
-        return apply_filters( 'bp_get_group_avatar', $avatar );
+        }
+
+        return apply_filters( 'bp_get_group_avatar', $avatar, $r );
     }