Changeset 13358 for trunk/src/bp-xprofile/bp-xprofile-template.php

Timestamp:

11/08/2022 06:27:01 AM (3 years ago)

Author:

imath

Message:

xProfile: allow the loop to fetch fields from multiple fields group

You can now pass an array of fields group ID into the $profile_group_id
parameter.

Props boonebgorges, espellcaste

Closes ​https://github.com/buddypress/buddypress/pull/30
Fixes #4075

File:

• trunk/src/bp-xprofile/bp-xprofile-template.php (modified) (2 diffs)

trunk/src/bp-xprofile/bp-xprofile-template.php

@@ -15 +15 @@
  *
  * @since 1.0.0
- * @since 2.4.0 Introduced `$member_type` argument.
- * @since 8.0.0 Introduced `$hide_field_types` & `$signup_fields_only` arguments.
+ * @since 2.4.0  Introduced `$member_type` argument.
+ * @since 8.0.0  Introduced `$hide_field_types` & `$signup_fields_only` arguments.
+ * @since 11.0.0 `$profile_group_id` accepts an array of profile group ids.
  *
  * @global object $profile_template
@@ -24 +25 @@
  *     Array of arguments. See BP_XProfile_Group::get() for full description. Those arguments whose defaults differ
  *     from that method are described here:
- *     @type int          $user_id                Default: ID of the displayed user.
- *     @type string|array $member_type            Default: 'any'.
- *     @type int|bool     $profile_group_id       Default: false.
- *     @type bool         $hide_empty_groups      Default: true.
- *     @type bool         $hide_empty_fields      Defaults to true on the Dashboard, on a user's Edit Profile page,
- *                                                or during registration. Otherwise false.
- *     @type bool         $fetch_fields           Default: true.
- *     @type bool         $fetch_field_data       Default: true.
- *     @type bool         $fetch_visibility_level Defaults to true when an admin is viewing a profile, or when a user is
- *                                                viewing her own profile, or during registration. Otherwise false.
- *     @type int[]|bool   $exclude_groups         Default: false.
- *     @type int[]|bool   $exclude_fields         Default: false.
- *     @type string[]     $hide_field_types       Default: empty array.
- *     @type bool         $signup_fields_only     Default: false.
- *     @type bool         $update_meta_cache      Default: true.
+ *     @type int            $user_id                Default: ID of the displayed user.
+ *     @type string|array   $member_type            Default: 'any'.
+ *     @type int|int[]|bool $profile_group_id       Default: false.
+ *     @type bool           $hide_empty_groups      Default: true.
+ *     @type bool           $hide_empty_fields      Defaults to true on the Dashboard, on a user's Edit Profile page,
+ *                                                  or during registration. Otherwise false.
+ *     @type bool           $fetch_fields           Default: true.
+ *     @type bool           $fetch_field_data       Default: true.
+ *     @type bool           $fetch_visibility_level Defaults to true when an admin is viewing a profile, or when a user is
+ *                                                  viewing her own profile, or during registration. Otherwise false.
+ *     @type int[]|bool     $exclude_groups         Default: false.
+ *     @type int[]|bool     $exclude_fields         Default: false.
+ *     @type string[]       $hide_field_types       Default: empty array.
+ *     @type bool           $signup_fields_only     Default: false.
+ *     @type bool           $update_meta_cache      Default: true.
  * }
- *
  * @return bool
  */