Changeset 13484 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

Timestamp:

05/20/2023 06:34:46 AM (3 years ago)

Author:

imath

Message:

Improve inline doc, informing about global variable usage in functions

In various xProfile component files, used globals are:

• $wpdb: the WordPress database object,
• $profile_template: the xProfile data template object,
• $group: the current group of profile fields in a loop,
• $field: the current field in a loop.

Props upadalavipul

Fixes #8890

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php (modified) (3 diffs)

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

@@ -255 +255 @@
      * @since 2.4.0
      * @since 2.8.0 Added `$user_id` and `$get_data` parameters.
+     *
+     * @global wpdb $wpdb WordPress database object.
      *
      * @static
@@ -926 +928 @@
      * Get the type for provided field ID.
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @param int $field_id Field ID to get type of.
      * @return bool|null|string
@@ -1057 +1061 @@
      *
      * @since 2.4.0
+     *
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param string|array $member_types Member type or array of member types. Use 'any' to return unrestricted