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

Timestamp:

08/10/2014 08:33:24 PM (10 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-functions.php (modified) (1 diff)

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

@@ -17 +17 @@
 
 /*** Field Group Management **************************************************/
+
+/**
+ * Fetch a set of field groups, populated with fields and field data.
+ *
+ * Procedural wrapper for BP_XProfile_Group::get() method.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $args See {@link BP_XProfile_Group::get()} for description of
+ *        arguments.
+ * @return array $groups
+ */
+function bp_xprofile_get_groups( $args = array() ) {
+
+    $groups = BP_XProfile_Group::get( $args );
+
+    return apply_filters( 'bp_xprofile_get_groups', $groups, $args );
+}
 
 function xprofile_insert_field_group( $args = '' ) {