Changeset 12885 for trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

Timestamp:

04/16/2021 05:29:26 AM (4 years ago)

Author:

imath

Message:

Improve the Field/Group APIs to pick selected fields as signup ones

• Introduce the bp_xprofile_get_signup_field_ids() function to get an ordered list of field IDs to use as signup fields.
• Introduce the bp_xprofile_signup_args() function to get the signup arguments to use into the registration page xProfile loop. If no signup fields are available, it falls back to the primary fields group.
• Introduce the $signup_fields_only xProfile loop argument to restrict fetched fields to signup ones if set to true.
• Adapt the BP_XProfile_Data_Template class to build a unique xProfile field group out of any possible field groups containing one or more signup fields when the $signup_fields_only argument is set to true and registration is allowed on the site.
• Adapt the BP_XProfile_Field class to get the possible field's signup position and add a new metabox to add a field to signup ones from the xProfile Field Administration screen.
• Adapt the BP_XProfile_Group class to ignore non signup fields if the $signup_fields_only argument is set to true.

Props johnjamesjacoby, boonebgorges, DJPaul, Offereins

See #6347

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php (modified) (4 diffs)

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

@@ -239 +239 @@
      * @since 1.2.0
      * @since 2.4.0 Introduced `$member_type` argument.
-     * @since 8.0.0 Introduced `$hide_field_types` argument.
+     * @since 8.0.0 Introduced `$hide_field_types` & `$signup_fields_only` arguments.
      *
      * @global object $wpdb WordPress DB access object.
@@ -245 +245 @@
      * @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 array|string $member_type       Limit fields by those restricted to a given member type, or array of
-     *                                            member types. If `$user_id` is provided, the value of `$member_type`
-     *                                            will be overridden by the member types of the provided user. The
-     *                                            special value of 'any' will return only those fields that are
-     *                                            unrestricted by member type - i.e., those applicable to any type.
-     *      @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 int[]|bool   $exclude_groups    Comma-separated list or array of group IDs to exclude.
-     *      @type int[]|bool   $exclude_fields    Comma-separated list or array of field IDs to exclude.
-     *      @type string[]     $hide_field_types  List of field types to hide form loop. Default: empty array.
-     *      @type bool         $update_meta_cache Whether to pre-fetch xprofilemeta for all retrieved groups, fields,
-     *                                            and data. Default: true.
+     *      @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 array|string $member_type        Limit fields by those restricted to a given member type, or array of
+     *                                             member types. If `$user_id` is provided, the value of `$member_type`
+     *                                             will be overridden by the member types of the provided user. The
+     *                                             special value of 'any' will return only those fields that are
+     *                                             unrestricted by member type - i.e., those applicable to any type.
+     *      @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 int[]|bool   $exclude_groups     Comma-separated list or array of group IDs to exclude.
+     *      @type int[]|bool   $exclude_fields     Comma-separated list or array of field IDs to exclude.
+     *      @type string[]     $hide_field_types   List of field types to hide form loop. Default: empty array.
+     *      @type bool         $signup_fields_only Whether to only return signup fields. Default: false.
+     *      @type bool         $update_meta_cache  Whether to pre-fetch xprofilemeta for all retrieved groups, fields,
+     *                                             and data. Default: true.
      * }
      * @return array $groups
@@ -284 +285 @@
             'hide_field_types'       => array(),
             'update_meta_cache'      => true,
+            'signup_fields_only'     => false,
         ) );
 
@@ -343 +345 @@
         $fields = array();
         foreach ( $field_ids as $field_id ) {
+            if ( true === $r['signup_fields_only'] && ! in_array( $field_id, bp_xprofile_get_signup_field_ids(), true ) ) {
+                continue;
+            }
+
             $_field = xprofile_get_field( $field_id, null, false );