Changeset 8785

Timestamp:

08/10/2014 08:33:24 PM (11 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

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-admin.php (modified) (2 diffs)
• bp-xprofile-classes.php (modified) (2 diffs)
• bp-xprofile-functions.php (modified) (1 diff)
• bp-xprofile-template.php (modified) (2 diffs)

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

@@ -37 +37 @@
     $type = preg_replace( '|[^a-z]|i', '', $type );
 
-    $groups = BP_XProfile_Group::get( array(
+    $groups = bp_xprofile_get_groups( array(
         'fetch_fields' => true
     ) );
@@ -288 +288 @@
                 do_action( 'xprofile_fields_saved_field', $field );
 
-                $groups = BP_XProfile_Group::get();
+                $groups = bp_xprofile_get_groups();
                 xprofile_admin( $message, $type );
             }

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,

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 = '' ) {

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

@@ -26 +26 @@
 
     function __construct( $user_id, $profile_group_id, $hide_empty_groups = false, $fetch_fields = false, $fetch_field_data = false, $exclude_groups = false, $exclude_fields = false, $hide_empty_fields = false, $fetch_visibility_level = false, $update_meta_cache = true ) {
-        $this->groups = BP_XProfile_Group::get( array(
+        $this->groups = bp_xprofile_get_groups( array(
             'profile_group_id'    => $profile_group_id,
             'user_id'             => $user_id,
@@ -601 +601 @@
 
     if ( empty( $groups ) ) {
-        $groups = BP_XProfile_Group::get( array( 'fetch_fields' => true ) );
+        $groups = bp_xprofile_get_groups( array( 'fetch_fields' => true ) );
         wp_cache_set( 'xprofile_groups_inc_empty', $groups, 'bp' );
     }