Changeset 8672

Timestamp:

07/23/2014 01:42:48 PM (12 years ago)

Author:

boonebgorges

Message:

Introduce BP_XProfile_Field_Type::pre_validate_filter(), and use in URL field type

The pre_validate_filter() method allows field types to intercept field values,
before they are run through the is_valid() validation routine, and optionally
modify them.

BP_XProfile_Field_Type_URL uses this filter to silently add the '​http://'
protocol to submitted values before run through the validation regex (which
requires the protocol). The result is a smoother UX, as users are not required
to enter the protocol in order to have their field value saved.

To make it possible for protocol-less values to be submitted on the profile
edit form, the 'type' attribute of the URL field was changed from 'url' to
'text' (with a 'url' inputtype). With 'type=url', modern browsers require a
fully-qualified URL before allowing the form to be submitted.

Fixes #5501

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-classes.php (modified) (3 diffs)
• bp-xprofile-filters.php (modified) (2 diffs)
• bp-xprofile-functions.php (modified) (1 diff)

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

@@ -2646 +2646 @@
 
                 $r = bp_parse_args( $raw_properties, array(
-                        'type'  => 'url',
-                        'value' =>  esc_url( bp_get_the_profile_field_edit_value() ),
+                        'type'      => 'text',
+                        'inputmode' => 'url',
+                        'value'     => esc_url( bp_get_the_profile_field_edit_value() ),
                 ) ); ?>
 
@@ -2692 +2693 @@
          */
         public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
+
+        /**
+         * Modify submitted URL values before validation.
+         *
+         * The URL validation regex requires a http(s) protocol, so that all
+         * values saved in the database are fully-formed URLs. However, we
+         * still want to allow users to enter URLs without a protocol, for a
+         * better user experience. So we catch submitted URL values, and if
+         * the protocol is missing, we prepend 'http://' before passing to
+         * is_valid().
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param string $submitted_value Raw value submitted by the user.
+         * @return string
+         */
+        public static function pre_validate_filter( $submitted_value ) {
+                if ( false === strpos( $submitted_value, ':'  )
+                  && substr( $submitted_value, 0, 1 ) !== '/'
+                  && substr( $submitted_value, 0, 1 ) !== '#'
+                  && ! preg_match( '/^[a-z0-9-]+?\.php/i', $submitted_value )
+                ) {
+                        $submitted_value = 'http://' . $submitted_value;
+                }
+
+                return $submitted_value;
+        }
 
         /**
@@ -3065 +3093 @@
 
         /**
+         * Allow field types to modify submitted values before they are validated.
+         *
+         * In some cases, it may be appropriate for a field type to catch
+         * submitted values and modify them before they are passed to the
+         * is_valid() method. For example, URL validation requires the
+         * 'http://' scheme (so that the value saved in the database is always
+         * a fully-formed URL), but in order to allow users to enter a URL
+         * without this scheme, BP_XProfile_Field_Type_URL prepends 'http://'
+         * when it's not present.
+         *
+         * By default, this is a pass-through method that does nothing. Only
+         * override in your own field type if you need this kind of pre-
+         * validation filtering.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param mixed $submitted_value Submitted value.
+         * @return mixed
+         */
+        public static function pre_validate_filter( $field_value ) {
+                return $field_value;
+        }
+
+        /**
          * Allow field types to modify the appearance of their values.
          *

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

@@ -52 +52 @@
 add_filter( 'xprofile_get_field_data',                  'xprofile_filter_format_field_value_by_field_id', 5, 2 );
 
+add_filter( 'bp_xprofile_set_field_data_pre_validate',  'xprofile_filter_pre_validate_value_by_field_type', 10, 3 );
 add_filter( 'xprofile_data_value_before_save',          'xprofile_sanitize_data_value_before_save', 1, 4 );
 add_filter( 'xprofile_filtered_data_value_before_save', 'trim', 2 );
@@ -176 +177 @@
         $field = new BP_XProfile_Field( $field_id );
         return xprofile_filter_format_field_value_by_type( $field_value, $field->type );
+}
+
+/**
+ * Apply pre_validate_filter() filters as defined by the BP_XProfile_Field_Type classes before validating.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $value Value passed to the bp_xprofile_set_field_data_pre_validate
+ *        filter.
+ * @param BP_XProfile_Field $field Field object.
+ * @param BP_XProfile_Field_Type Field type object.
+ * @return mixed
+ */
+function xprofile_filter_pre_validate_value_by_field_type( $value, $field, $field_type_obj ) {
+        if ( method_exists( $field_type_obj, 'pre_validate_filter' ) ) {
+                $value = call_user_func( array( $field_type_obj, 'pre_validate_filter' ), $value );
+        }
+
+        return $value;
 }
 

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

@@ -294 +294 @@
                 return false;
 
-        // Special-case support for integer 0 for the number field type
-        if ( $is_required && ! is_integer( $value ) && $value !== '0' && ( empty( $value ) || ! is_array( $value ) && ! strlen( trim( $value ) ) ) ) {
-                return false;
-        }
-
         $field          = new BP_XProfile_Field( $field_id );
         $field_type     = BP_XProfile_Field::get_type( $field_id );
         $field_type_obj = bp_xprofile_create_field_type( $field_type );
+
+        /**
+         * Filter the raw submitted profile field value.
+         *
+         * Use this filter to modify the values submitted by users before
+         * doing field-type-specific validation.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param mixed $value Value passed to xprofile_set_field_data()
+         * @param BP_XProfile_Field $field Field object.
+         * @param BP_XProfile_Field_Type $field_type_obj Field type object.
+         */
+        $value = apply_filters( 'bp_xprofile_set_field_data_pre_validate', $value, $field, $field_type_obj );
+
+        // Special-case support for integer 0 for the number field type
+        if ( $is_required && ! is_integer( $value ) && $value !== '0' && ( empty( $value ) || ! is_array( $value ) && ! strlen( trim( $value ) ) ) ) {
+                return false;
+        }
 
         /**