Changeset 12869

Timestamp:

03/22/2021 07:45:24 PM (6 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

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-cache.php (modified) (1 diff)
• bp-xprofile-filters.php (modified) (1 diff)
• bp-xprofile-functions.php (modified) (4 diffs)
• classes/class-bp-xprofile-component.php (modified) (1 diff)
• classes/class-bp-xprofile-profiledata.php (modified) (9 diffs)
• classes/class-bp-xprofile-user-admin.php (modified) (1 diff)
• screens/edit.php (modified) (2 diffs)

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

@@ -303 +303 @@
 // List actions to clear super cached pages on, if super cache is installed.
 add_action( 'xprofile_updated_profile', 'bp_core_clear_cache' );
+
+/**
+ * Resets the User Metadata ids cache.
+ *
+ * @since 8.0.0
+ *
+ * @param integer $user_id The user ID.
+ */
+function bp_xprofile_reset_user_mid_cache( $user_id ) {
+        wp_cache_delete( $user_id, 'bp_user_mid' );
+}
+add_action( 'profile_update', 'bp_xprofile_reset_user_mid_cache', 10, 1 );

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

@@ -353 +353 @@
  */
 function bp_xprofile_escape_field_data( $value, $field_type, $field_id ) {
+        // Sanitization for these types is directly done into their `display_filter()` method.
+        if ( 'wp-biography' === $field_type || 'wp-textbox' === $field_type ) {
+                return $value;
+        }
+
         if ( bp_xprofile_is_richtext_enabled_for_field( $field_id ) ) {
                 // The xprofile_filter_kses() expects a BP_XProfile_ProfileData object.

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() )
+        );
+}

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

@@ -411 +411 @@
                         'bp_xprofile_fields',
                         'bp_xprofile_groups',
-                        'xprofile_meta'
+                        'xprofile_meta',
+                        'bp_user_mid',
                 ) );
 

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;
 

trunk/src/bp-xprofile/classes/class-bp-xprofile-user-admin.php

@@ -273 +273 @@
                 $r = bp_parse_args( $args['args'], array(
                         'profile_group_id' => 0,
-                        'user_id'          => $user->ID
+                        'user_id'          => $user->ID,
+                        'hide_field_types' => array( 'wp-textbox', 'wp-biography' ),
                 ), 'bp_xprofile_user_admin_profile_loop_args' );
 

trunk/src/bp-xprofile/screens/edit.php

@@ -50 +50 @@
                 $posted_field_ids = wp_parse_id_list( $_POST['field_ids'] );
                 $is_required      = array();
+
+                $bp_displayed_user = bp_get_displayed_user();
+                $bp_displayed_user->updated_keys = array();
 
                 // Loop through the posted fields formatting any datebox values then validate the field.
@@ -127 +130 @@
                         do_action( 'xprofile_updated_profile', bp_displayed_user_id(), $posted_field_ids, $errors, $old_values, $new_values );
 
+                        // Some WP User keys have been updated: let's update the WP fiels all together.
+                        if ( $bp_displayed_user->updated_keys ) {
+                                $user_id = wp_update_user(
+                                        array_merge(
+                                                array(
+                                                        'ID' => bp_displayed_user_id(),
+                                                ),
+                                                $bp_displayed_user->updated_keys
+                                        )
+                                );
+
+                                $bp_displayed_user->updated_keys = array();
+
+                                if ( is_wp_error( $user_id ) ) {
+                                        $errors = true;
+                                }
+                        }
+
                         // Set the feedback messages.
                         if ( !empty( $errors ) ) {