Changeset 10009 for trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

Timestamp:

07/11/2015 10:17:38 AM (9 years ago)

Author:

boonebgorges

Message:

Improve formatting of BP_XProfile_Group::get() docblock.

See #5192.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php (modified) (1 diff)

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

@@ -230 +230 @@
      * @param array $args {
      *  Array of optional arguments:
-     *  @type int $profile_group_id Limit results to a single profile
-     *        group.
-     *      @type int $user_id Required if you want to load a specific
-     *            user's data. Default: displayed user's ID.
-     *      @type bool $hide_empty_groups True to hide groups that don't
-     *            have any fields. Default: false.
-     *  @type bool $hide_empty_fields True to hide fields where the
-     *        user has not provided data. Default: false.
-     *      @type bool $fetch_fields Whether to fetch each group's fields.
-     *            Default: false.
-     *      @type bool $fetch_field_data Whether to fetch data for each
-     *            field. Requires a $user_id. Default: false.
-     *      @type array $exclude_groups Comma-separated list or array of
-     *            group IDs to exclude.
-     *      @type array $exclude_fields Comma-separated list or array of
-     *            field IDs to exclude.
-     *      @type bool $update_meta_cache Whether to pre-fetch xprofilemeta
-     *            for all retrieved groups, fields, and data. Default: true.
+     *  @type int   $profile_group_id  Limit results to a single profile group.
+     *      @type int   $user_id           Required if you want to load a specific user's data.
+     *                                     Default: displayed user's ID.
+     *      @type bool  $hide_empty_groups True to hide groups that don't have any fields. Default: false.
+     *  @type bool  $hide_empty_fields True to hide fields where the user has not provided data. Default: false.
+     *      @type bool  $fetch_fields      Whether to fetch each group's fields. Default: false.
+     *      @type bool  $fetch_field_data  Whether to fetch data for each field. Requires a $user_id.
+     *                                     Default: false.
+     *      @type array $exclude_groups    Comma-separated list or array of group IDs to exclude.
+     *      @type array $exclude_fields    Comma-separated list or array of field IDs to exclude.
+     *      @type bool  $update_meta_cache Whether to pre-fetch xprofilemeta for all retrieved groups, fields,
+     *                                     and data. Default: true.
      * }
      * @return array $groups