Changeset 10254

Timestamp:

10/12/2015 05:50:45 PM (9 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.

Location:

trunk

Files:

• src/bp-templates/bp-legacy/css/buddypress.css (modified) (2 diffs)
• src/bp-templates/bp-legacy/css/twentyfifteen.css (modified) (1 diff)
• src/bp-templates/bp-legacy/css/twentyfifteen.scss (modified) (1 diff)
• src/bp-xprofile/bp-xprofile-filters.php (modified) (5 diffs)
• src/bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)
• src/bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php (modified) (4 diffs)
• src/bp-xprofile/classes/class-bp-xprofile-field-type.php (modified) (1 diff)
• tests/phpunit/testcases/xprofile/functions.php (modified) (1 diff)

trunk/src/bp-templates/bp-legacy/css/buddypress.css

@@ -841 +841 @@
 #buddypress .wp-editor-wrap input[type=button],
 #buddypress .wp-editor-wrap input[type=reset] {
-    padding: 0 10px 1px;
+    padding: 0 8px 1px;
 }
 
@@ -1585 +1585 @@
     margin: 0;
 }
+#buddypress .wp-editor-container {
+    border: 1px solid #dedede;
+}
+#buddypress .html-active button.switch-html {
+    border-bottom-color: transparent;
+    border-bottom-left-radius: 0;
+    border-bottom-right-radius: 0;
+    background: #f5f5f5;
+}
+#buddypress .tmce-active button.switch-tmce {
+    border-bottom-color: transparent;
+    border-bottom-left-radius: 0;
+    border-bottom-right-radius: 0;
+    background: #f5f5f5;
+}
+#buddypress .standard-form .wp-editor-container textarea {
+    width: 100%;
+    padding-top: 0;
+    padding-bottom: 0;
+}
 
 /*--------------------------------------------------------------

trunk/src/bp-templates/bp-legacy/css/twentyfifteen.css

@@ -1709 +1709 @@
 }
 
+#buddypress .wp-editor-wrap a.button,
+#buddypress .wp-editor-wrap button,
+#buddypress .wp-editor-wrap input[type=submit],
+#buddypress .wp-editor-wrap input[type=button],
+#buddypress .wp-editor-wrap input[type=reset] {
+    padding: 0 5px 1px;
+}
+
 #buddypress .standard-form li,
 #buddypress .group-create-form li {

trunk/src/bp-templates/bp-legacy/css/twentyfifteen.scss

@@ -2041 +2041 @@
     select {border: 1px solid rgba($border-color, 0.5);}
 
+    // Overrides for embedded WP editors.
+    .wp-editor-wrap {
+        a.button,
+        button,
+        input[type=submit],
+        input[type=button],
+        input[type=reset] {
+            padding: 0 5px 1px;
+        }
+    }
+
 } // close #buddypress
 

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

@@ -24 +24 @@
 add_filter( 'bp_get_the_profile_field_value',           'force_balance_tags' );
 add_filter( 'bp_get_the_profile_field_value',           'make_clickable'     );
-add_filter( 'bp_get_the_profile_field_value',           'esc_html',        8 );
+add_filter( 'bp_get_the_profile_field_value',           'bp_xprofile_escape_field_data', 8, 3 );
 add_filter( 'bp_get_the_profile_field_value',           'convert_smilies', 9 );
 add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_format_field_value',         1, 2 );
@@ -31 +31 @@
 
 add_filter( 'bp_get_the_profile_field_edit_value',      'force_balance_tags' );
-add_filter( 'bp_get_the_profile_field_edit_value',      'esc_html'           );
+add_filter( 'bp_get_the_profile_field_edit_value',      'bp_xprofile_escape_field_data', 10, 3 );
 
 add_filter( 'bp_get_the_profile_group_name',            'stripslashes' );
@@ -40 +40 @@
 add_filter( 'bp_get_the_profile_field_description',     'stripslashes' );
 
-add_filter( 'xprofile_get_field_data',                  'wp_filter_kses', 1 );
+add_filter( 'xprofile_get_field_data',                  'xprofile_filter_kses', 1 );
 add_filter( 'xprofile_field_name_before_save',          'wp_filter_kses', 1 );
 add_filter( 'xprofile_field_description_before_save',   'wp_filter_kses', 1 );
@@ -124 +124 @@
     $xprofile_allowedtags             = $allowedtags;
     $xprofile_allowedtags['a']['rel'] = array();
+
+    // If the field supports rich text, we must allow tags that appear in wp_editor().
+    if ( $data_obj instanceof BP_XProfile_ProfileData && bp_xprofile_is_richtext_enabled_for_field( $data_obj->field_id ) ) {
+        $richtext_tags = array(
+            'img'  => array( 'id' => 1, 'class' => 1, 'src' => 1, 'alt' => 1, 'width' => 1, 'height' => 1 ),
+            'ul'   => array( 'id' => 1, 'class' => 1 ),
+            'ol'   => array( 'id' => 1, 'class' => 1 ),
+            'li'   => array( 'id' => 1, 'class' => 1 ),
+            'span' => array( 'style' => 1 ),
+            'p'    => array( 'style' => 1 ),
+        );
+
+        $xprofile_allowedtags = array_merge( $allowedtags, $richtext_tags );
+    }
 
     /**
@@ -275 +289 @@
     if ( method_exists( $field_type_obj, 'pre_validate_filter' ) ) {
         $value = call_user_func( array( $field_type_obj, 'pre_validate_filter' ), $value );
+    }
+
+    return $value;
+}
+
+/**
+ * Escape field value for display.
+ *
+ * Most field values are simply run through esc_html(). Those that support rich text (by default, `textarea` only)
+ * are sanitized using kses, which allows a whitelist of HTML tags.
+ *
+ * @since 2.4.0
+ *
+ * @param string $value      Field value.
+ * @param string $field_type Field type.
+ * @param int    $field_id   Field ID.
+ * @return string
+ */
+function bp_xprofile_escape_field_data( $value, $field_type, $field_id ) {
+    if ( bp_xprofile_is_richtext_enabled_for_field( $field_id ) ) {
+        // xprofile_filter_kses() expects a BP_XProfile_ProfileData object.
+        $data_obj = null;
+        if ( bp_is_user() ) {
+            $data_obj = new BP_XProfile_ProfileData( $field_id, bp_displayed_user_id() );
+        }
+
+        $value = xprofile_filter_kses( $value, $data_obj );
+    } else {
+        $value = esc_html( $value );
     }
 

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.
  *

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php

@@ -27 +27 @@
         $this->category = _x( 'Single Fields', 'xprofile field type category', 'buddypress' );
         $this->name     = _x( 'Multi-line Text Area', 'xprofile field type', 'buddypress' );
+        $this->supports_richtext = true;
 
         $this->set_format( '/^.*$/m', 'replace' );
@@ -60 +61 @@
         }
 
-        $r = bp_parse_args( $raw_properties, array(
-            'cols' => 40,
-            'rows' => 5,
-        ) ); ?>
+        $richtext_enabled = bp_xprofile_is_richtext_enabled_for_field(); ?>
 
         <label for="<?php bp_the_profile_field_input_name(); ?>">
@@ -73 +71 @@
 
         /** This action is documented in bp-xprofile/bp-xprofile-classes */
-        do_action( bp_get_the_profile_field_errors_action() ); ?>
+        do_action( bp_get_the_profile_field_errors_action() );
 
-        <textarea <?php echo $this->get_edit_field_html_elements( $r ); ?>><?php bp_the_profile_field_edit_value(); ?></textarea>
+        if ( ! $richtext_enabled ) {
+            $r = wp_parse_args( $raw_properties, array(
+                'cols' => 40,
+                'rows' => 5,
+            ) );
 
-        <?php
+            ?>
+
+            <textarea <?php echo $this->get_edit_field_html_elements( $r ); ?>><?php bp_the_profile_field_edit_value(); ?></textarea>
+
+            <?php
+
+        } else {
+
+            /**
+             * Filters the arguments passed to `wp_editor()` in richtext xprofile fields.
+             *
+             * @since 2.4.0
+             *
+             * @param array $args {
+             *     Array of optional arguments. See `wp_editor()`.
+             *     @type bool $teeny         Whether to use the teeny version of TinyMCE. Default true.
+             *     @type bool $media_buttons Whether to show media buttons. Default false.
+             *     @type bool $quicktags     Whether to show the quicktags buttons. Default true.
+             * }
+             */
+            $editor_args = apply_filters( 'bp_xprofile_field_type_textarea_editor_args', array(
+                'teeny'         => true,
+                'media_buttons' => false,
+                'quicktags'     => true,
+            ) );
+
+            wp_editor(
+                bp_get_the_profile_field_edit_value(),
+                bp_get_the_profile_field_input_name(),
+                $editor_args
+            );
+        }
     }
 
@@ -90 +123 @@
      */
     public function admin_field_html( array $raw_properties = array() ) {
-        $r = bp_parse_args( $raw_properties, array(
-            'cols' => 40,
-            'rows' => 5,
-        ) ); ?>
+        $richtext_enabled = bp_xprofile_is_richtext_enabled_for_field();
 
-        <textarea <?php echo $this->get_edit_field_html_elements( $r ); ?>></textarea>
+        if ( ! $richtext_enabled ) {
 
-        <?php
+            $r = bp_parse_args( $raw_properties, array(
+                'cols' => 40,
+                'rows' => 5,
+            ) ); ?>
+
+            <textarea <?php echo $this->get_edit_field_html_elements( $r ); ?>></textarea>
+
+            <?php
+        } else {
+
+            /** This filter is documented in bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php */
+            $editor_args = apply_filters( 'bp_xprofile_field_type_textarea_editor_args', array(
+                'teeny'         => true,
+                'media_buttons' => false,
+                'quicktags'     => true,
+            ) );
+
+            wp_editor(
+                '',
+                'xprofile_textarea_' . bp_get_the_profile_field_id(),
+                $editor_args
+            );
+        }
     }
 

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type.php

@@ -72 +72 @@
      */
     public $supports_multiple_defaults = false;
+
+    /**
+     * If the field type supports rich text by default.
+     *
+     * @since 2.4.0
+     * @var bool
+     */
+    public $supports_richtext = false;
 
     /**

trunk/tests/phpunit/testcases/xprofile/functions.php

@@ -914 +914 @@
         $this->assertSame( $num_queries, $wpdb->num_queries );
     }
+
+    /**
+     * @ticket BP5625
+     */
+    public function test_bp_xprofie_is_richtext_enabled_for_field_should_default_to_true_for_textareas() {
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g,
+            'type' => 'textarea',
+        ) );
+
+        $this->assertTrue( bp_xprofile_is_richtext_enabled_for_field( $f ) );
+    }
+
+    /**
+     * @ticket BP5625
+     */
+    public function test_bp_xprofie_is_richtext_enabled_for_field_should_default_to_false_for_non_textareas() {
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g,
+            'type' => 'radio',
+        ) );
+
+        $this->assertFalse( bp_xprofile_is_richtext_enabled_for_field( $f ) );
+    }
 }