Changeset 8459

Timestamp:

05/28/2014 09:00:39 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Groups - template file clean-up:

• Introduce missing bp_current_group_description() functions to match id/name/slug pairings.
• Use groups_get_current_group() where global touches were being used (likely more to do here.)
• Normalize _current_group_ functions to all use the general same approach and filtering techniques.
• Add filter to the end of bp_groups_get_action_link() and do some general clean-up around it.

File:

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

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

@@ -1515 +1515 @@
 
 function bp_group_admin_tabs( $group = false ) {
-    global $bp, $groups_template;
-
-    if ( empty( $group ) )
-        $group = ( $groups_template->group ) ? $groups_template->group : $bp->groups->current_group;
+    global $groups_template;
+
+    if ( empty( $group ) ) {
+        $group = ( $groups_template->group ) ? $groups_template->group : groups_get_current_group();
+    }
 
     $current_tab = bp_get_group_current_admin_tab();
@@ -3447 +3448 @@
 
     if ( empty( $r['group_id'] ) ) {
-        if ( ! empty( buddypress()->groups->current_group ) ) {
+        if ( groups_get_current_group() ) {
             $r['group_id'] = bp_get_current_group_id();
-        } else if ( ! empty( buddypress()->groups->new_group_id ) ) {
+        } elseif ( ! empty( buddypress()->groups->new_group_id ) ) {
             $r['group_id'] = buddypress()->groups->new_group_id;
         }
@@ -3601 +3602 @@
 }
     function bp_get_group_activity_feed_link() {
-        global $bp;
-
-        return apply_filters( 'bp_get_group_activity_feed_link', bp_get_group_permalink( $bp->groups->current_group ) . 'feed/' );
+        return apply_filters( 'bp_get_group_activity_feed_link', bp_get_group_permalink( groups_get_current_group() ) . 'feed/' );
     }
 
@@ -3625 +3624 @@
      */
     function bp_get_current_group_id() {
-        $current_group = groups_get_current_group();
-
+        $current_group    = groups_get_current_group();
         $current_group_id = isset( $current_group->id ) ? (int) $current_group->id : 0;
 
@@ -3651 +3649 @@
      */
     function bp_get_current_group_slug() {
-        $current_group = groups_get_current_group();
-
+        $current_group      = groups_get_current_group();
         $current_group_slug = isset( $current_group->slug ) ? $current_group->slug : '';
 
@@ -3676 +3673 @@
      */
     function bp_get_current_group_name() {
-        global $bp;
-
-        $name = apply_filters( 'bp_get_group_name', $bp->groups->current_group->name );
-        return apply_filters( 'bp_get_current_group_name', $name );
-    }
-
+        $current_group      = groups_get_current_group();
+        $current_group_name = isset( $current_group->name ) ? $current_group->name : '';
+        $name               = apply_filters( 'bp_get_group_name', $current_group_name );
+
+        return apply_filters( 'bp_get_current_group_name', $name, $current_group );
+    }
+
+/**
+ * Echoes the output of bp_get_current_group_description()
+ *
+ * @package BuddyPress
+ * @since BuddyPress (2.1.0)
+ */
+function bp_current_group_description() {
+    echo bp_get_current_group_description();
+}
+    /**
+     * Returns the description of the current group
+     *
+     * @package BuddyPress
+     * @since BuddyPress (2.1.0)
+     * @uses apply_filters() Filter bp_get_current_group_description to modify
+     *                       this output
+     *
+     * @return string The description of the current group, if there is one
+     */
+    function bp_get_current_group_description() {
+        $current_group      = groups_get_current_group();
+        $current_group_desc = isset( $current_group->description ) ? $current_group->description : '';
+        $desc               = apply_filters( 'bp_get_group_description', $current_group_desc );
+
+        return apply_filters( 'bp_get_current_group_description', $desc );
+    }
+
+/**
+ * Output a URL for a group component action
+ *
+ * @since BuddyPress (1.2)
+ *
+ * @param string $action
+ * @param string $query_args
+ * @param bool $nonce
+ * @return string
+ */
 function bp_groups_action_link( $action = '', $query_args = '', $nonce = false ) {
     echo bp_get_groups_action_link( $action, $query_args, $nonce );
 }
+    /**
+     * Get a URL for a group component action
+     *
+     * @since BuddyPress (1.2)
+     *
+     * @param string $action
+     * @param string $query_args
+     * @param bool $nonce
+     * @return string
+     */
     function bp_get_groups_action_link( $action = '', $query_args = '', $nonce = false ) {
-        global $bp;
+
+        $current_group = groups_get_current_group();
+        $url           = '';
 
         // Must be a group
-        if ( empty( $bp->groups->current_group->id ) )
-            return;
-
-        // Append $action to $url if provided
-        if ( !empty( $action ) )
-            $url = bp_get_group_permalink( groups_get_current_group() ) . $action;
-        else
-            $url = bp_get_group_permalink( groups_get_current_group() );
-
-        // Add a slash at the end of our user url
-        $url = trailingslashit( $url );
-
-        // Add possible query arg
-        if ( !empty( $query_args ) && is_array( $query_args ) )
-            $url = add_query_arg( $query_args, $url );
-
-        // To nonce, or not to nonce...
-        if ( true === $nonce )
-            $url = wp_nonce_url( $url );
-        elseif ( is_string( $nonce ) )
-            $url = wp_nonce_url( $url, $nonce );
-
-        // Return the url, if there is one
-        if ( !empty( $url ) )
-            return $url;
+        if ( ! empty( $current_group->id ) ) {
+
+            // Append $action to $url if provided
+            if ( !empty( $action ) ) {
+                $url = bp_get_group_permalink( $current_group ) . $action;
+            } else {
+                $url = bp_get_group_permalink( $current_group );
+            }
+
+            // Add a slash at the end of our user url
+            $url = trailingslashit( $url );
+
+            // Add possible 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 ) {
+                $url = wp_nonce_url( $url );
+            } elseif ( is_string( $nonce ) ) {
+                $url = wp_nonce_url( $url, $nonce );
+            }
+        }
+
+        // Return the url
+        return apply_filters( 'bp_get_groups_action_link', $url, $action, $query_args, $nonce );
     }