Changeset 5926 for trunk/bp-xprofile/bp-xprofile-functions.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-xprofile/bp-xprofile-functions.php (modified) (2 diffs)

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -192 +192 @@
  * @param $user_id The ID of the user
  * @param $value The value for the field you want to set for the user.
- * @global object $bp Global BuddyPress settings object
+ * @global BuddyPress $bp The one true BuddyPress instance
  * @uses xprofile_get_field_id_from_name() Gets the ID for the field based on the name.
  * @return true on success, false on failure.
@@ -329 +329 @@
  * @param $user_id User ID of the user to get random data for
  * @param $exclude_fullname whether or not to exclude the full name field as random data.
- * @global object $bp Global BuddyPress settings object
+ * @global BuddyPress $bp The one true BuddyPress instance
  * @global $wpdb WordPress DB access object.
  * @global $current_user WordPress global variable containing current logged in user information