Changeset 10022 for trunk/src/bp-xprofile/bp-xprofile-template.php

Timestamp:

07/21/2015 02:00:38 PM (11 years ago)

Author:

boonebgorges

Message:

Allow xProfile fields to be restricted to users belonging to one or more member types.

A new metabox on the profile field edit panel allows the administrator to
select the member types to which the field is applicable. Admins can also
choose to have a field apply to users who do not belong to any member type.
Information about a field's member type associations is displayed on the
Users > Profile Fields page, alongside each field name.

During registration, the only fields that are displayed are those that are
unrestricted - that is, those available to all users, regardless of member type
(or lack thereof).

This changeset introduces a number of new methods on BP_XProfile_Field that
developers should use to manipulate member type information:
get_member_types(), set_member_types(), and the static
get_fields_for_member_type(). In addition to member types that have been
explicitly registered, 'null' is a pseudo-type representing users who do not
belong to a member type.

This changeset introduces a blacklist of illegal member type names. By default,
the blacklist includes 'any', 'null', and '_none'. Use the
'bp_member_type_illegal_names' filter to add names to the blacklist.

Props Offereins, boonebgorges, tanner m, imath.
See #5192.

File:

• trunk/src/bp-xprofile/bp-xprofile-template.php (modified) (4 diffs)

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

@@ -111 +111 @@
 
     /**
-     * Get activity items, as specified by parameters
+     * Get activity items, as specified by parameters.
+     *
+     * @see BP_XProfile_Group::get() for more details about parameters.
+     *
+     * @since BuddyPress (2.4.0) Introduced `$member_type` argument.
      *
      * @param array $args {
      *     An array of arguments. All items are optional.
      *
-     *     @type int       $user_id                 Fetch field data for this user ID
-     *     @type int       $profile_group_id        Field group to fetch fields & data for
-     *     @type int|bool  $hide_empty_groups       Should empty field groups be skipped
-     *     @type int|bool  $fetch_fields            Fetch fields for field group
-     *     @type int|bool  $fetch_field_data        Fetch field data for fields in group
-     *     @type array     $exclude_groups          Exclude these field groups
-     *     @type array     $exclude_fields          Exclude these fields
-     *     @type int|bool  $hide_empty_fields       Should empty fields be skipped
-     *     @type int|bool  $fetch_visibility_level  Fetch visibility levels
-     *     @type int|bool  $update_meta_cache       Should metadata cache be updated
+     *     @type int          $user_id                 Fetch field data for this user ID.
+     *     @type string|array $member_type             Limit results to those matching member type(s).
+     *     @type int          $profile_group_id        Field group to fetch fields & data for.
+     *     @type int|bool     $hide_empty_groups       Should empty field groups be skipped.
+     *     @type int|bool     $fetch_fields            Fetch fields for field group.
+     *     @type int|bool     $fetch_field_data        Fetch field data for fields in group.
+     *     @type array        $exclude_groups          Exclude these field groups.
+     *     @type array        $exclude_fields          Exclude these fields.
+     *     @type int|bool     $hide_empty_fields       Should empty fields be skipped.
+     *     @type int|bool     $fetch_visibility_level  Fetch visibility levels.
+     *     @type int|bool     $update_meta_cache       Should metadata cache be updated.
      * }
      */
@@ -154 +159 @@
             'profile_group_id'       => false,
             'user_id'                => false,
+            'member_type'            => 'any',
             'hide_empty_groups'      => false,
             'hide_empty_fields'      => false,
@@ -318 +324 @@
  *     Array of arguments. See BP_XProfile_Group::get() for full description. Those arguments whose defaults differ
  *     from that method are described here:
- *     @type bool $hide_empty_groups      Default: true.
- *     @type bool $hide_empty_fields      Defaults to true on the Dashboard, on a user's Edit Profile page,
- *                                        or during registration. Otherwise false.
- *     @type bool $fetch_visibility_level Defaults to true when an admin is viewing a profile, or when a user is
- *                                        viewing her own profile, or during registration. Otherwise false.
- *     @type bool $fetch_fields           Default: true.
- *     @type bool $fetch_field_data       Default: true.
+ *     @type string|array $member_type            Default: 'any'.
+ *     @type bool         $hide_empty_groups      Default: true.
+ *     @type bool         $hide_empty_fields      Defaults to true on the Dashboard, on a user's Edit Profile page,
+ *                                                or during registration. Otherwise false.
+ *     @type bool         $fetch_visibility_level Defaults to true when an admin is viewing a profile, or when a user is
+ *                                                viewing her own profile, or during registration. Otherwise false.
+ *     @type bool         $fetch_fields           Default: true.
+ *     @type bool         $fetch_field_data       Default: true.
  * }
  *
@@ -346 +353 @@
     $r = bp_parse_args( $args, array(
         'user_id'                => bp_displayed_user_id(),
+        'member_type'            => 'any',
         'profile_group_id'       => false,
         'hide_empty_groups'      => true,