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

Timestamp:

03/22/2021 07:45:24 PM (4 years ago)

Author:

imath

Message:

Prepare the xProfile component to handle the WordPress field types

• Add a cache group to cache usermeta IDs by user IDs to avoid requesting information more than necessary when it hasn't been updated.
• Edit the Profile field sanitization filter bp_xprofile_escape_field_data so that WordPress fields are escaped the way WordPress does.
• Add the two new Field types wp-biography & wp-textbox to the available ones. See bp_xprofile_get_field_types().
• Introduce the bp_xprofile_get_field_type() function to get the fied type of a field thanks to its ID.
• Introduce a new filter bp_xprofile_set_field_data_pre_save. This filter returns false by default. You can use it to avoid using the Profile data DB table to save a field value by returning a WP_Error object or true. This filter is used by the WordPress field types to avoid duplicating the corresponding usermeta values into the Profile data DB table.
• Introduce the bp_xprofile_get_wp_user_keys() function to inform about the supported WordPress fields (first_name, last_name, user_url, description and potential WP contact methods).
• Edit the BP_XProfile_ProfileData methods to fetch field data so that they now try to fetch data within the usermeta table if the xProfile field has a WordPress field type.
• Deprecate the BP_XProfile_ProfileData::get_value_byfieldname() as it's no more used into BP Core code.
• Edit the function used to output the fields into the WP Admin/Extended profile screen so that WordPress fields are ignored as they can be updated from the WP Admin regular profile.

Props DJPaul, Offereins, needle, netweb, vapvarun

See #7162

File:

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

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

@@ -160 +160 @@
         'textbox'        => 'BP_XProfile_Field_Type_Textbox',
         'telephone'      => 'BP_XProfile_Field_Type_Telephone',
+        'wp-biography'   => 'BP_XProfile_Field_Type_WordPress_Biography',
+        'wp-textbox'     => 'BP_XProfile_Field_Type_WordPress_Textbox',
     );
 
@@ -312 +314 @@
 
 /**
+ * Get a profile Field Type object.
+ *
+ * @since 8.0.0
+ *
+ * @param int $field_id ID of the field.
+ * @return BP_XProfile_Field_Type|null Field Type object if found, otherwise null.
+ */
+function bp_xprofile_get_field_type( $field_id ) {
+    $field_type = null;
+    $field      = xprofile_get_field( $field_id, null, false );
+
+    if ( $field instanceof BP_XProfile_Field ) {
+        $field_type = $field->type_obj;
+    }
+
+    return $field_type;
+}
+
+/**
  * Delete a profile field object.
  *
@@ -463 +484 @@
     }
 
-    $field           = new BP_XProfile_ProfileData();
-    $field->field_id = $field_id;
-    $field->user_id  = $user_id;
-
-    // Gets un/reserialized via xprofile_sanitize_data_value_before_save().
-    $field->value    = maybe_serialize( $value );
-
-    return $field->save();
+    $field_args = compact( 'field_type_obj', 'field', 'user_id', 'value', 'is_required' );
+
+    /**
+     * Return a WP_Error object or true to use your custom way of saving field values.
+     *
+     * @since 8.0.0
+     *
+     * @param boolean Whether to shortcircuit the $bp->profile->table_name_data table.
+     * @param array $field_args {
+     *     An array of arguments.
+     *
+     *     @type object            $field_type_obj Field type object.
+     *     @type BP_XProfile_Field $field          Field object.
+     *     @type integer           $user_id        The user ID.
+     *     @type mixed             $value          Value passed to xprofile_set_field_data().
+     *     @type boolean           $is_required    Whether or not the field is required.
+     * }
+     */
+    $retval = apply_filters( 'bp_xprofile_set_field_data_pre_save', false, $field_args );
+
+    if ( is_wp_error( $retval ) ) {
+        return false;
+    }
+
+    if ( false === $retval ) {
+        $field           = new BP_XProfile_ProfileData();
+        $field->field_id = $field_id;
+        $field->user_id  = $user_id;
+
+        // Gets un/reserialized via xprofile_sanitize_data_value_before_save().
+        $field->value    = maybe_serialize( $value );
+
+        $retval = $field->save();
+    }
+
+    return $retval;
 }
 
@@ -1358 +1407 @@
     );
 }
+
+/**
+ * Returns the list of supporterd WordPress field meta keys.
+ *
+ * @since 8.0.0
+ *
+ * @return string[] List of supported WordPress user keys.
+ */
+function bp_xprofile_get_wp_user_keys() {
+    return array_merge(
+        array( 'first_name', 'last_name', 'user_url', 'description' ),
+        array_keys( wp_get_user_contact_methods() )
+    );
+}