Changeset 8336 for trunk/bp-xprofile/bp-xprofile-classes.php

Timestamp:

05/01/2014 10:33:57 PM (11 years ago)

Author:

djpaul

Message:

xProfile: prevent duplicate profile field templating when using pre-2.0 custom field types.

Prior to the xProfile field type overhaul in 2.0, plugins that added custom field types had to do so with a variety of actions.
One such plugin is "Buddypress Xprofile Custom Fields Type" and the changes in 2.0 caused an issue where the plugin's custom
templating was being rendered, alongside BuddyPress' profile field fallback type, the textbox.

BuddyPress uses a fallback field type to handle situations when extra profile types/data are provided by another plugin, and
then that plugin is removed. The original idea was that everything would fallback to rendering a textbox if a field type was
unregistered to give at least some kind of access to that profile field's data, but in practice this has caused a couple of
issues with templating, as this commit addresses.

This change essentially reverts the fallback behaviour to the pre-2.0 implementation: if a custom field type is unknown to
BuddyPress, that field simply won't be rendered.

Fixes #5589

File:

• trunk/bp-xprofile/bp-xprofile-classes.php (modified) (1 diff)

trunk/bp-xprofile/bp-xprofile-classes.php

@@ -2498 +2498 @@
 
 /**
+ * A placeholder xprofile field type. Doesn't do anything.
+ *
+ * Used if an existing field has an unknown type (e.g. one provided by a missing third-party plugin).
+ *
+ * @since BuddyPress (2.0.1)
+ */
+class BP_XProfile_Field_Type_Placeholder extends BP_XProfile_Field_Type {
+
+    /**
+     * Constructor for the placeholder field type.
+     *
+     * @since BuddyPress (2.0.1)
+     */
+    public function __construct() {
+    }
+
+    /**
+     * Prevent any HTML being output for this field type.
+     *
+     * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.text.html permitted attributes} that you want to add.
+     * @since BuddyPress (2.0.1)
+     */
+    public function edit_field_html( array $raw_properties = array() ) {
+    }
+
+    /**
+     * Prevent any HTML being output for this field type.
+     *
+     * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
+     * @since BuddyPress (2.0.1)
+     */
+    public function admin_field_html( array $raw_properties = array() ) {
+    }
+
+    /**
+     * Prevent any HTML being output for this field type.
+     *
+     * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
+     * @param string $control_type Optional. HTML input type used to render the current field's child options.
+     * @since BuddyPress (2.0.1)
+     */
+    public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
+}
+
+/**
  * Represents a type of XProfile field and holds meta information about the type of value that it accepts.
  *