Changeset 8819

Timestamp:

08/13/2014 12:30:12 AM (10 years ago)

Author:

boonebgorges

Message:

Introduce bp_the_profile_field_ids(), and use as appropriate throughout BP

The POST routine run when editing one's xprofile-powered profile (or
registering for an account when the registration form includes xprofile fields)
works in part by sending a list of field IDs in the 'field_ids' <input> element.
These field IDs are then used to decide which POST keys to look for when saving
submitted profile values. Historically, the function powering this field_ids
element has been bp_the_profile_group_field_ids(), which pulls up only the
field IDs from a single field group. Normally this works fine, because the
typical Profile > Edit screen only allows for the editing of a single field
group at a time. However, the introduction in BP 2.0 of Settings > Profile
demonstrates that this technique breaks when attempting to save more than one
field group at a time.

The new bp_the_profile_field_ids() replaces this logic by pulling up all the
field_ids from all the groups in the $profile_template global object.

In order to provide for backward compatibility with themes that may have
overridden the modified templates (in particular, members/single/settings/profile.php),
we add logic to the Settings > Profile save routine that looks for any
submitted profile fields that are not present in the field_ids array.

Fixes #5666

Props boonebgorges, r-a-y

Location:

trunk/src

Files:

• bp-templates/bp-legacy/buddypress/members/register.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/members/single/profile/edit.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/members/single/settings/profile.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-actions.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-template.php (modified) (1 diff)

trunk/src/bp-templates/bp-legacy/buddypress/members/register.php

@@ -105 +105 @@
                     <?php endwhile; ?>
 
-                    <input type="hidden" name="signup_profile_field_ids" id="signup_profile_field_ids" value="<?php bp_the_profile_group_field_ids(); ?>" />
+                    <input type="hidden" name="signup_profile_field_ids" id="signup_profile_field_ids" value="<?php bp_the_profile_field_ids(); ?>" />
 
                     <?php endwhile; endif; endif; ?>

trunk/src/bp-templates/bp-legacy/buddypress/members/single/profile/edit.php

@@ -64 +64 @@
     </div>
 
-    <input type="hidden" name="field_ids" id="field_ids" value="<?php bp_the_profile_group_field_ids(); ?>" />
+    <input type="hidden" name="field_ids" id="field_ids" value="<?php bp_the_profile_field_ids(); ?>" />
 
     <?php wp_nonce_field( 'bp_xprofile_edit' ); ?>

trunk/src/bp-templates/bp-legacy/buddypress/members/single/settings/profile.php

@@ -47 +47 @@
     <?php wp_nonce_field( 'bp_xprofile_settings' ); ?>
 
-    <input type="hidden" name="field_ids" id="field_ids" value="<?php bp_the_profile_group_field_ids(); ?>" />
+    <input type="hidden" name="field_ids" id="field_ids" value="<?php bp_the_profile_field_ids(); ?>" />
 
 </form>

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

@@ -86 +86 @@
         $posted_field_ids = explode( ',', $_POST['field_ids'] );
 
+        // Backward compatibility: a bug in BP 2.0 caused only a single
+        // group's field IDs to be submitted. Look for values submitted
+        // in the POST request that may not appear in 'field_ids', and
+        // add them to the list of IDs to save.
+        foreach ( $_POST as $posted_key => $posted_value ) {
+            preg_match( '/^field_([0-9]+)_visibility$/', $posted_key, $matches );
+            if ( ! empty( $matches[1] ) && ! in_array( $matches[1], $posted_field_ids ) ) {
+                $posted_field_ids[] = $matches[1];
+            }
+        }
+
         // Save the visibility settings
         foreach ( $posted_field_ids as $field_id ) {

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

@@ -313 +313 @@
 
         return substr( $field_ids, 0, -1 );
+    }
+
+/**
+ * Output a comma-separated list of field IDs that are to be submitted on profile edit.
+ *
+ * @since BuddyPress (2.1.0)
+ */
+function bp_the_profile_field_ids() {
+    echo bp_get_the_profile_field_ids();
+}
+    /**
+     * Generate a comma-separated list of field IDs that are to be submitted on profile edit.
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @return string
+     */
+    function bp_get_the_profile_field_ids() {
+        global $profile_template;
+
+        $field_ids = array();
+        foreach ( $profile_template->groups as $group ) {
+            $field_ids = array_merge( $field_ids, wp_list_pluck( $group->fields, 'id' ) );
+        }
+
+        $field_ids = implode( ',', wp_parse_id_list( $field_ids ) );
+
+        return apply_filters( 'bp_get_tthe_profile_field_ids', $field_ids );
     }