Skip to:
Content

BuddyPress.org

Changeset 10009


Ignore:
Timestamp:
07/11/2015 10:17:38 AM (5 years ago)
Author:
boonebgorges
Message:

Improve formatting of BP_XProfile_Group::get() docblock.

See #5192.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

    r10002 r10009  
    230230     * @param array $args {
    231231     *  Array of optional arguments:
    232      *  @type int $profile_group_id Limit results to a single profile
    233      *        group.
    234      *      @type int $user_id Required if you want to load a specific
    235      *            user's data. Default: displayed user's ID.
    236      *      @type bool $hide_empty_groups True to hide groups that don't
    237      *            have any fields. Default: false.
    238      *  @type bool $hide_empty_fields True to hide fields where the
    239      *        user has not provided data. Default: false.
    240      *      @type bool $fetch_fields Whether to fetch each group's fields.
    241      *            Default: false.
    242      *      @type bool $fetch_field_data Whether to fetch data for each
    243      *            field. Requires a $user_id. Default: false.
    244      *      @type array $exclude_groups Comma-separated list or array of
    245      *            group IDs to exclude.
    246      *      @type array $exclude_fields Comma-separated list or array of
    247      *            field IDs to exclude.
    248      *      @type bool $update_meta_cache Whether to pre-fetch xprofilemeta
    249      *            for all retrieved groups, fields, and data. Default: true.
     232     *  @type int   $profile_group_id  Limit results to a single profile group.
     233     *      @type int   $user_id           Required if you want to load a specific user's data.
     234     *                                     Default: displayed user's ID.
     235     *      @type bool  $hide_empty_groups True to hide groups that don't have any fields. Default: false.
     236     *  @type bool  $hide_empty_fields True to hide fields where the user has not provided data. Default: false.
     237     *      @type bool  $fetch_fields      Whether to fetch each group's fields. Default: false.
     238     *      @type bool  $fetch_field_data  Whether to fetch data for each field. Requires a $user_id.
     239     *                                     Default: false.
     240     *      @type array $exclude_groups    Comma-separated list or array of group IDs to exclude.
     241     *      @type array $exclude_fields    Comma-separated list or array of field IDs to exclude.
     242     *      @type bool  $update_meta_cache Whether to pre-fetch xprofilemeta for all retrieved groups, fields,
     243     *                                     and data. Default: true.
    250244     * }
    251245     * @return array $groups
Note: See TracChangeset for help on using the changeset viewer.