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

Timestamp:

04/16/2021 05:29:26 AM (5 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/bp-xprofile-functions.php (modified) (1 diff)

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

@@ -1422 +1422 @@
     );
 }
+
+/**
+ * Returns the signup field IDs.
+ *
+ * @since 8.0.0
+ *
+ * @return int[] The signup field IDs.
+ */
+function bp_xprofile_get_signup_field_ids() {
+    $signup_field_ids = wp_cache_get( 'signup_fields', 'bp_xprofile' );
+
+    if ( ! $signup_field_ids ) {
+        global $wpdb;
+        $bp = buddypress();
+
+        $signup_field_ids = $wpdb->get_col( "SELECT object_id FROM {$bp->profile->table_name_meta} WHERE object_type = 'field' AND meta_key = 'signup_position' ORDER BY meta_value ASC" );
+
+        wp_cache_set( 'signup_fields', $signup_field_ids, 'bp_xprofile' );
+    }
+
+    return array_map( 'intval', $signup_field_ids );
+}
+
+/**
+ * Returns xProfile loop's signup arguments.
+ *
+ * @since 8.0.0
+ *
+ * @param array $extra Optional extra arguments.
+ * @return array The xProfile loop's signup arguments.
+ */
+function bp_xprofile_signup_args( $extra = array() ) {
+    $signup_fields = (array) bp_xprofile_get_signup_field_ids();
+    $default_args  = array(
+        'fetch_fields'     => true,
+        'fetch_field_data' => false,
+    );
+
+    // No signup fields? Let's bring back primary group.
+    if ( ! $signup_fields && bp_is_register_page() ) {
+        $default_args['profile_group_id'] = 1;
+    } else {
+        $default_args['signup_fields_only'] = true;
+    }
+
+    return array_merge( $default_args, $extra );
+}