Changeset 5926 for trunk/bp-core/bp-core-template.php

Timestamp:

03/16/2012 12:52:24 AM (14 years ago)

Author:

johnjamesjacoby

Message:

Replace ambiguous 'object' phpdoc references with more accurate descriptions for the $bp global

File:

• trunk/bp-core/bp-core-template.php (modified) (5 diffs)

trunk/bp-core/bp-core-template.php

@@ -15 +15 @@
  *
  * @package BuddyPress Core
- * @global object $bp Global BuddyPress settings object
+ * @global BuddyPress $bp The one true BuddyPress instance
  * @uses bp_get_user_nav() Renders the navigation for a profile of a currently viewed user.
  */
@@ -75 +75 @@
  *
  * @package BuddyPress Core
- * @global object $bp Global BuddyPress settings object
+ * @global BuddyPress $bp The one true BuddyPress instance
  */
 function bp_has_options_avatar() {
@@ -650 +650 @@
      * @since 1.5
      *
-     * @global object $bp Global BuddyPress settings object
+     * @global BuddyPress $bp The one true BuddyPress instance
      * @param string $component Optional. Defaults to the current component
      * @return string $root_slug The root slug
@@ -686 +686 @@
  *
  * @since BuddyPress {r3923}
- * @global object $bp Global BuddyPress settings object
+ * @global BuddyPress $bp The one true BuddyPress instance
  * @param str $root_slug Needle to our active component haystack
  * @return mixed False if none found, component name if found
@@ -954 +954 @@
  * page in wp-admin's Settings > Reading screen.
  *
- * @global object $bp Global BuddyPress settings object
+ * @global BuddyPress $bp The one true BuddyPress instance
  * @global $current_blog WordPress global for the current blog
  * @param string $component Optional; Name of the component to check for.