Changeset 8672 for trunk/src/bp-xprofile/bp-xprofile-classes.php

Timestamp:

07/23/2014 01:42:48 PM (11 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

File:

• trunk/src/bp-xprofile/bp-xprofile-classes.php (modified) (3 diffs)

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