Changeset 3730

Timestamp:

01/18/2011 06:03:57 PM (16 years ago)

Author:

djpaul

Message:

Correct phpdoc for bp_get_displayed_user_nav(). Fixes #3011, props LanceHudson

File:

• trunk/bp-core/bp-core-templatetags.php (modified) (10 diffs)

trunk/bp-core/bp-core-templatetags.php

@@ -455 +455 @@
         global $bp;
 
-        $default_search_value = bp_get_search_default_text(); 
+        $default_search_value = bp_get_search_default_text();
         $search_value = !empty( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : $default_search_value;
 
@@ -534 +534 @@
 
 /**
- * bp_get_displayed_user_nav()
- * TEMPLATE TAG
- *
- * Uses the $bp->bp_users_nav global to render out the user navigation when viewing another user other than
+ * Uses the $bp->bp_nav global to render out the user navigation when viewing another user other than
  * yourself.
  *
@@ -583 +580 @@
 function bp_get_options_nav() {
         global $bp;
-        
+
         // If we are looking at a member profile, then the we can use the current component as an
         // index. Otherwise we need to use the component's root_slug
         $component_index = !empty( $bp->displayed_user ) ? $bp->current_component : bp_get_root_slug( $bp->current_component );
-        
+
         if ( count( $bp->bp_options_nav[$component_index] ) < 1 )
                 return false;
@@ -1053 +1050 @@
 }
 
-/** 
- * Get the default text for the search box for a given component. 
- * 
- * @global object $bp BuddyPress global settings 
- * @return string 
- * @since 1.3 
- */ 
-function bp_search_default_text() { 
-        echo bp_get_search_default_text(); 
-} 
-        function bp_get_search_default_text( $component = false ) { 
-                global $bp; 
-                
-                if ( empty( $component ) ) 
+/**
+ * Get the default text for the search box for a given component.
+ *
+ * @global object $bp BuddyPress global settings
+ * @return string
+ * @since 1.3
+ */
+function bp_search_default_text() {
+        echo bp_get_search_default_text();
+}
+        function bp_get_search_default_text( $component = false ) {
+                global $bp;
+
+                if ( empty( $component ) )
                         $component = $bp->current_component;
-                
+
                 $default_text = __( 'Search anything...', 'buddypress' );
-                
+
                 if ( !empty( $bp->default_search_strings[$component] ) ) {
                         // Most of the time, $component will be the actual component name
@@ -1083 +1080 @@
                         }
                 }
-                
-                return apply_filters( 'bp_search_default_text', $default_text, $component ); 
-        } 
+
+                return apply_filters( 'bp_search_default_text', $default_text, $component );
+        }
 
 function bp_search_form() {
@@ -1121 +1118 @@
 /**
  * Creates and outputs a button.
- * 
+ *
  * @param array $args See bp_get_button() for the list of arguments.
  * @see bp_get_button()
@@ -1174 +1171 @@
 
         preg_match( "%\s*((?:<[^>]+>)+\S*)\s*|\s+%s", $text, $matches, PREG_OFFSET_CAPTURE, $excerpt_length );
-        
+
         if ( !empty( $matches ) ) {
-                $pos = array_pop( array_pop( $matches ) );      
+                $pos = array_pop( array_pop( $matches ) );
                 $text = substr( $text, 0, $pos ) . ' [...]';
         }
-        
+
         return apply_filters( 'bp_create_excerpt', $text, $original_text );
 }
@@ -1606 +1603 @@
 
                         // Component has specific root slug
-                        if ( !empty( $bp->{$component_name}->root_slug ) ) 
+                        if ( !empty( $bp->{$component_name}->root_slug ) )
                                 $root_slug = $bp->{$component_name}->root_slug;
                 }
@@ -1904 +1901 @@
 function bp_is_user_groups() {
         global $bp;
-        
+
         if ( bp_is_current_component( BP_GROUPS_SLUG ) )
                 return true;
@@ -1913 +1910 @@
 function bp_is_group() {
         global $bp;
-        
+
         if ( bp_is_current_component( BP_GROUPS_SLUG ) && isset( $bp->groups->current_group ) && $bp->groups->current_group )
                 return true;