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

Timestamp:

10/12/2015 05:50:45 PM (10 years ago)

Author:

boonebgorges

Message:

Enable richtext editing for xProfile textarea fields.

Profile fields of the 'textarea' type are now edited using wp_editor().
Output escaping has been modified to whitelist all tags permitted by the
"teeny" version of the wp_editor() interface.

Richtext is enabled for all and only 'textarea' fields:

• To enable richtext editing for a custom field type, set the supports_richtext property of your BP_XProfile_Field_Type class to true. In these cases, you'll need to provide your own editing markup as well; see the edit_field_html() and admin_field_html() methods of BP_XProfile_Field_Type_Textarea for inspiration.
• To disable richtext editing for specific 'textarea' fields, filter bp_xprofile_is_richtext_enabled_for_field.

Props needle, boonebgorges.
Fixes #5625.

File:

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

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

@@ -1021 +1021 @@
 
 /**
+ * Is rich text enabled for this profile field?
+ *
+ * By default, rich text is enabled for textarea fields and disabled for all other field types.
+ *
+ * @since 2.4.0
+ *
+ * @param int $field_id Optional. Default current field ID.
+ * @return bool
+ */
+function bp_xprofile_is_richtext_enabled_for_field( $field_id = null ) {
+    if ( ! $field_id ) {
+        $field_id = bp_get_the_profile_field_id();
+    }
+
+    $field = xprofile_get_field( $field_id );
+
+    $enabled = false;
+    if ( $field instanceof BP_XProfile_Field ) {
+        $enabled = (bool) $field->type_obj->supports_richtext;
+    }
+
+    /**
+     * Filters whether richtext is enabled for the given field.
+     *
+     * @since 2.4.0
+     *
+     * @param bool $enabled  True if richtext is enabled for the field, otherwise false.
+     * @param int  $field_id ID of the field.
+     */
+    return apply_filters( 'bp_xprofile_is_richtext_enabled_for_field', $enabled, $field_id );
+}
+
+/**
  * Get visibility levels out of the $bp global.
  *