Changeset 12869 for trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.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/classes/class-bp-xprofile-profiledata.php (modified) (9 diffs)

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

@@ -317 +317 @@
      *
      * @since 2.0.0
-     *
-     * @param int   $user_id   ID of user whose data is being queried.
-     * @param array $field_ids Array of field IDs to query for.
+     * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
+     *              Adds a new parameter `$field_type_objects` to pass the list of field type objects.
+     *
+     * @param int   $user_id            ID of user whose data is being queried.
+     * @param array $field_ids          Array of field IDs to query for.
+     * @param array $field_type_objects Array of field type objects keyed by the queried filed IDs.
      * @return array
      */
-    public static function get_data_for_user( $user_id, $field_ids ) {
+    public static function get_data_for_user( $user_id, $field_ids, $field_type_objects = array() ) {
         global $wpdb;
 
@@ -340 +343 @@
                 $d               = new stdClass;
                 $d->id           = $ud->id;
+                $d->table_name   = $bp->profile->table_name_data;
                 $d->user_id      = $ud->user_id;
                 $d->field_id     = $ud->field_id;
@@ -360 +364 @@
                 // to avoid future cache misses.
                 } else {
-                    $d               = new stdClass;
-                    $d->id           = '';
+                    $d = new stdClass;
+
+                    // Check WordPress if it's a WordPress field.
+                    if ( isset( $field_type_objects[ $field_id ]->wp_user_key ) ) {
+                        $meta          = $field_type_objects[ $field_id ]->get_field_value( $user_id, $field_id );
+                        $d->id         = $meta['id'];
+                        $d->value      = $meta['value'];
+                        $d->table_name = $meta['table_name'];
+
+                    } else {
+                        $d->id    = '';
+                        $d->value = '';
+                    }
+
+                    $d->table_name   = '';
                     $d->user_id      = $user_id;
                     $d->field_id     = $field_id;
-                    $d->value        = '';
                     $d->last_updated = '';
 
@@ -397 +413 @@
      *
      * @since 1.2.0
+     * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
      *
      * @param int $user_id ID of the user.
@@ -431 +448 @@
                         'field_id'         => $field->id,
                         'field_type'       => $field->type,
-                        'field_data'       => $field->data->value,
                     );
+
+                    if ( is_null( $field->data ) ) {
+                        if ( 1 === $field->id ) {
+                            $profile_data[ $field->name ]['field_data'] = $user->display_name;
+                        } elseif ( isset( $field->type_obj ) && $field->type_obj instanceof BP_XProfile_Field_Type && isset( $field->type_obj->wp_user_key ) ) {
+                            $meta = $field->type_obj->get_field_value( $user->ID, $field->id );
+
+                            if ( isset( $meta['value'] ) ) {
+                                $profile_data[ $field->name ]['field_data'] = $meta['value'];
+                            }
+                        } else {
+                            $profile_data[ $field->name ]['field_data'] = false;
+                        }
+                    } else {
+                        $profile_data[ $field->name ]['field_data'] = $field->data->value;
+                    }
                 }
             }
@@ -476 +508 @@
      *
      * @since 1.0.0
+     * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
      *
      * @param int            $field_id ID of the field.
@@ -525 +558 @@
                 // avoid cache misses and PHP notices.
                 } else {
-                    $d = new stdClass;
-                    $d->id           = '';
+                    $d          = new stdClass;
+                    $field_type = bp_xprofile_get_field_type( $field_id );
+
+                    // Check WordPress if it's a WordPress field.
+                    if ( isset( $field_type->wp_user_key ) ) {
+                        $meta          = $field_type->get_field_value( $user_id, $field_id );
+                        $d->id         = $meta['id'];
+                        $d->value      = $meta['value'];
+                        $d->table_name = $meta['table_name'];
+
+                    } else {
+                        $d->id    = '';
+                        $d->value = '';
+                    }
+
+                    $d->table_name   = '';
                     $d->user_id      = $id;
                     $d->field_id     = $field_id;
-                    $d->value        = '';
                     $d->last_updated = '';
                 }
@@ -571 +617 @@
      *
      * @since 1.0.0
+     * @deprecated 8.0.0 This function is not used anymore.
      *
      * @param array|string $fields  Field(s) to get.
@@ -577 +624 @@
      */
     public static function get_value_byfieldname( $fields, $user_id = null ) {
+        _deprecated_function( __FUNCTION__, '8.0.0' );
         global $wpdb;