Changeset 8785 for trunk/src/bp-xprofile/bp-xprofile-classes.php

Timestamp:

08/10/2014 08:33:24 PM (12 years ago)

Author:

boonebgorges

Message:

Introduce bp_xprofile_get_groups() procedural wrapper for BP_XProfile_Group::get()

This wrapper includes a filter on the return values, so that plugin authors can
manipulate data programatically.

Also includes some documentation improvements, and implements new function
throughout BP.

See #5657

Props tw2113

File:

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

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

@@ -109 +109 @@
          * @global BuddyPress $bp The one true BuddyPress instance
          *
-         * @param array $args Takes an array of parameters:
-         *              'profile_group_id' - Limit results to a single profile group
-         *              'user_id' - Required if you want to load a specific user's data
-         *              'hide_empty_groups' - Hide groups without any fields
-         *              'hide_empty_fields' - Hide fields where the user has not provided data
-         *              'fetch_fields' - Load each group's fields
-         *              'fetch_field_data' - Load each field's data. Requires a user_id
-         *              'exclude_groups' - Comma-separated list of groups to exclude
-         *              'exclude_fields' - Comma-separated list of fields to exclude
-         *              'update_meta_cache' - Whether to pre-fetch xprofilemeta
-         *                 for all retrieved groups, fields, and data
-         *
+         * @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.
+         * }
          * @return array $groups
          */
@@ -1224 +1233 @@
                 global $wpdb, $bp;
 
-                $groups = BP_XProfile_Group::get( array(
+                $groups = bp_xprofile_get_groups( array(
                         'user_id'                => $user_id,
                         'hide_empty_groups'      => true,