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

Timestamp:

11/08/2022 06:27:01 AM (4 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/classes/class-bp-xprofile-data-template.php (modified) (1 diff)

trunk/src/bp-xprofile/classes/class-bp-xprofile-data-template.php

@@ -105 +105 @@
          *
          * @since 1.5.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.
          *
          * @param array|string $args {
          *     An array of arguments. All items are optional.
          *
-         *     @type int          $user_id                 Fetch field data for this user ID.
-         *     @type string|array $member_type             Limit results to those matching member type(s).
-         *     @type int          $profile_group_id        Field group to fetch fields & data for.
-         *     @type int|bool     $hide_empty_groups       Should empty field groups be skipped.
-         *     @type int|bool     $fetch_fields            Fetch fields for field group.
-         *     @type int|bool     $fetch_field_data        Fetch field data for fields in group.
-         *     @type array        $exclude_groups          Exclude these field groups.
-         *     @type array        $exclude_fields          Exclude these fields.
-         *     @type int|bool     $hide_empty_fields       Should empty fields be skipped.
-         *     @type int|bool     $fetch_visibility_level  Fetch visibility levels.
-         *     @type string[]     $hide_field_types        List of field types to hide form loop. Default: empty array.
-         *     @type bool         $signup_fields_only      Whether to only return signup fields. Default: false.
-         *     @type int|bool     $update_meta_cache       Should metadata cache be updated.
+         *     @type int            $user_id                 Fetch field data for this user ID.
+         *     @type string|array   $member_type             Limit results to those matching member type(s).
+         *     @type int|int[]|bool $profile_group_id        Field group(s) to fetch fields & data for. Default: false.
+         *     @type int|bool       $hide_empty_groups       Should empty field groups be skipped.
+         *     @type int|bool       $fetch_fields            Fetch fields for field group.
+         *     @type int|bool       $fetch_field_data        Fetch field data for fields in group.
+         *     @type array          $exclude_groups          Exclude these field groups.
+         *     @type array          $exclude_fields          Exclude these fields.
+         *     @type int|bool       $hide_empty_fields       Should empty fields be skipped.
+         *     @type int|bool       $fetch_visibility_level  Fetch visibility levels.
+         *     @type string[]       $hide_field_types        List of field types to hide form loop. Default: empty array.
+         *     @type bool           $signup_fields_only      Whether to only return signup fields. Default: false.
+         *     @type int|bool       $update_meta_cache       Should metadata cache be updated.
          * }
          */