Changeset 5926 for trunk/bp-core/bp-core-classes.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-classes.php (modified) (10 diffs)

trunk/bp-core/bp-core-classes.php

@@ -374 +374 @@
          * Fetches the user details for all the users who username starts with the letter given.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param string $letter The letter the users names are to start with.
@@ -482 +482 @@
          * Find users who match on the value of an xprofile data.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param string $search_terms The terms to search the profile table value column for.
@@ -526 +526 @@
          * Accepts multiple user IDs to fetch data for.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param array $paged_users an array of stdClass containing the users
@@ -707 +707 @@
          * Update or insert notification details into the database.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @return bool Success or failure
@@ -736 +736 @@
          * Fetches the notification data from the database.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          */
@@ -764 +764 @@
          * Fetches all the notifications in the database for a specific user.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param integer $user_id User ID
@@ -782 +782 @@
          * Delete all the notifications for a user based on the component name and action.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param integer $user_id
@@ -798 +798 @@
          * Delete all the notifications that have a specific item id, component name and action.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param integer $user_id The ID of the user who the notifications are for.
@@ -818 +818 @@
          * Deletes all the notifications sent by a specific user, by component and action.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param integer $user_id The ID of the user whose sent notifications we wish to delete.
@@ -834 +834 @@
          * Deletes all the notifications for all users by item id, and optional secondary item id, and component name and action.
          *
-         * @global object $bp Global BuddyPress settings object
+         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @param string $item_id The item id that they notifications are to be for.