Changeset 13475

Timestamp:

05/13/2023 08:57:35 AM (19 months ago)

Author:

imath

Message:

Improve inline doc, informing about $wpdb usage in functions

Props upadalavipul

Fixes #8890

Location:

trunk/src/bp-xprofile/classes

Files:

• class-bp-xprofile-group.php (modified) (5 diffs)
• class-bp-xprofile-meta-query.php (modified) (1 diff)
• class-bp-xprofile-profiledata.php (modified) (10 diffs)
• class-bp-xprofile-query.php (modified) (1 diff)

trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

@@ -84 +84 @@
      *
      * @since 1.0.0
-     *
-     * @global wpdb $wpdb WordPress database object.
      *
      * @param int $id Field group ID.
@@ -468 +466 @@
      * @since 5.0.0
      * @since 11.0.0 `$profile_group_id` accepts an array of profile group ids.
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array $args {
@@ -525 +525 @@
      *
      * @since 5.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array $group_ids Array of group IDs.
@@ -617 +619 @@
      *
      * @since 2.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array $group_ids Array of IDs.
@@ -787 +791 @@
      *
      * @since 1.6.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @return array $default_visibility_levels An array, keyed by field_id, of default

trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php

@@ -153 +153 @@
      *
      * @since 2.3.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array  $clause       Query clause, passed by reference.

trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php

@@ -77 +77 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int $field_id Field ID to populate.
@@ -176 +178 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @return bool
@@ -318 +322 @@
      * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
      *              Adds a new parameter `$field_type_objects` to pass the list of field type objects.
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int   $user_id            ID of user whose data is being queried.
@@ -475 +481 @@
      *
      * @since 1.6.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int $field_id Field ID being queried for.
@@ -508 +516 @@
      * @since 1.0.0
      * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int            $field_id ID of the field.
@@ -616 +626 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
+     * 
      * @deprecated 8.0.0 This function is not used anymore.
      *
@@ -682 +695 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int $field_id ID of the field to delete.
@@ -702 +717 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int $user_id User ID to get time for.
@@ -720 +737 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int $user_id User ID to remove data for.
@@ -746 +765 @@
      *
      * @since 1.0.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param int    $user_id          User ID to query for.

trunk/src/bp-xprofile/classes/class-bp-xprofile-query.php

@@ -341 +341 @@
      *
      * @since 2.2.0
+     * 
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array $clause       Query clause.