Changeset 9329

Timestamp:

01/09/2015 06:34:41 PM (10 years ago)

Author:

r-a-y

Message:

Core: Introduce bp_form_field_attributes() function.

bp_form_field_attributes() is a helper function to output attributes for
a given field.

The function:

• Sets some default attributes for the username, email and password input fields to better support touchscreen devices.
• Allows plugin developers to arbitrarily filter the attributes for the given field.
• Is used in BP_XProfile_Type::get_edit_field_html_elements() to better filter fields by input name.

Props hnla, standardspace, boonebgorges, johnjamesjacoby.

Fixes #5914.

Location:

trunk/src

Files:

• bp-blogs/bp-blogs-template.php (modified) (1 diff)
• bp-core/bp-core-template.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/members/register.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/members/single/settings/general.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-classes.php (modified) (1 diff)

trunk/src/bp-blogs/bp-blogs-template.php

@@ -1224 +1224 @@
         echo '<span class="prefix_address">' . $current_site->domain . $current_site->path . '</span> <input name="blogname" type="text" id="blogname" value="'.$blogname.'" maxlength="63" /><br />';
     else
-        echo '<input name="blogname" type="text" id="blogname" value="'.$blogname.'" maxlength="63" /> <span class="suffix_address">.' . bp_blogs_get_subdomain_base() . '</span><br />';
+        echo '<input name="blogname" type="text" id="blogname" value="'.$blogname.'" maxlength="63" ' . bp_get_form_field_attributes( 'blogname' ) . '/> <span class="suffix_address">.' . bp_blogs_get_subdomain_base() . '</span><br />';
 
     if ( !is_user_logged_in() ) {

trunk/src/bp-core/bp-core-template.php

@@ -491 +491 @@
     do_action( 'bp_custom_profile_sidebar_boxes' );
 }
+
+/**
+ * Output the attributes for a form field.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param string $name       The field name to output attributes for.
+ * @param array  $attributes Array of existing attributes to add.
+ */
+function bp_form_field_attributes( $name = '', $attributes = array() ) {
+    echo bp_get_form_field_attributes( $name, $attributes );
+}
+    /**
+     * Get the attributes for a form field.
+     *
+     * Primarily to add better support for touchscreen devices, but plugin devs
+     * can use the 'bp_get_form_field_extra_attributes' filter for further
+     * manipulation.
+     *
+     * @since BuddyPress (2.2.0)
+     *
+     * @param string $name       The field name to get attributes for.
+     * @param array  $attributes Array of existing attributes to add.
+     * @return string
+     */
+    function bp_get_form_field_attributes( $name = '', $attributes = array() ) {
+        $retval = '';
+
+        if ( empty( $attributes ) ) {
+            $attributes = array();
+        }
+
+        $name = strtolower( $name );
+
+        switch ( $name ) {
+            case 'username' :
+            case 'blogname' :
+                $attributes['autocomplete']   = 'off';
+                $attributes['autocapitalize'] = 'none';
+                break;
+
+            case 'email' :
+                if ( wp_is_mobile() ) {
+                    $attributes['autocapitalize'] = 'none';
+                }
+                break;
+
+            case 'password' :
+                $attributes['spellcheck']   = 'false';
+                $attributes['autocomplete'] = 'off';
+
+                if ( wp_is_mobile() ) {
+                    $attributes['autocorrect']    = 'false';
+                    $attributes['autocapitalize'] = 'none';
+                }
+                break;
+        }
+
+        /**
+         * Filter the attributes for a field before rendering output.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param array  $attributes The field attributes
+         * @param string $name       The field name
+         */
+        $attributes = (array) apply_filters( 'bp_get_form_field_attributes', $attributes, $name );
+
+        $attributes = array_unique( $attributes );
+
+        foreach( $attributes as $attr => $value ) {
+            $retval .= sprintf( ' %s="%s"', sanitize_key( $attr ), esc_attr( $value ) );
+        }
+
+        return $retval;
+    }
 
 /**

trunk/src/bp-templates/bp-legacy/buddypress/members/register.php

@@ -32 +32 @@
                 <label for="signup_username"><?php _e( 'Username', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
                 <?php do_action( 'bp_signup_username_errors' ); ?>
-                <input type="text" name="signup_username" id="signup_username" value="<?php bp_signup_username_value(); ?>" />
+                <input type="text" name="signup_username" id="signup_username" value="<?php bp_signup_username_value(); ?>" <?php bp_form_field_attributes( 'username' ); ?>/>
 
                 <label for="signup_email"><?php _e( 'Email Address', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
                 <?php do_action( 'bp_signup_email_errors' ); ?>
-                <input type="email" name="signup_email" id="signup_email" value="<?php bp_signup_email_value(); ?>" />
+                <input type="email" name="signup_email" id="signup_email" value="<?php bp_signup_email_value(); ?>" <?php bp_form_field_attributes( 'email' ); ?>/>
 
                 <label for="signup_password"><?php _e( 'Choose a Password', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
                 <?php do_action( 'bp_signup_password_errors' ); ?>
-                <input type="password" name="signup_password" id="signup_password" value="" class="password-entry" />
+                <input type="password" name="signup_password" id="signup_password" value="" class="password-entry" <?php bp_form_field_attributes( 'password' ); ?>/>
                 <div id="pass-strength-result"></div>
 
                 <label for="signup_password_confirm"><?php _e( 'Confirm Password', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
                 <?php do_action( 'bp_signup_password_confirm_errors' ); ?>
-                <input type="password" name="signup_password_confirm" id="signup_password_confirm" value="" class="password-entry-confirm" />
+                <input type="password" name="signup_password_confirm" id="signup_password_confirm" value="" class="password-entry-confirm" <?php bp_form_field_attributes( 'password' ); ?>/>
 
                 <?php do_action( 'bp_account_details_fields' ); ?>

trunk/src/bp-templates/bp-legacy/buddypress/members/single/settings/general.php

@@ -6 +6 @@
 
         <label for="pwd"><?php _e( 'Current Password <span>(required to update email or change current password)</span>', 'buddypress' ); ?></label>
-        <input type="password" name="pwd" id="pwd" size="16" value="" class="settings-input small" /> &nbsp;<a href="<?php echo wp_lostpassword_url(); ?>" title="<?php esc_attr_e( 'Password Lost and Found', 'buddypress' ); ?>"><?php _e( 'Lost your password?', 'buddypress' ); ?></a>
+        <input type="password" name="pwd" id="pwd" size="16" value="" class="settings-input small" <?php bp_form_field_attributes( 'password' ); ?>/> &nbsp;<a href="<?php echo wp_lostpassword_url(); ?>" title="<?php esc_attr_e( 'Password Lost and Found', 'buddypress' ); ?>"><?php _e( 'Lost your password?', 'buddypress' ); ?></a>
 
     <?php endif; ?>
 
     <label for="email"><?php _e( 'Account Email', 'buddypress' ); ?></label>
-    <input type="email" name="email" id="email" value="<?php echo bp_get_displayed_user_email(); ?>" class="settings-input" />
+    <input type="email" name="email" id="email" value="<?php echo bp_get_displayed_user_email(); ?>" class="settings-input" <?php bp_form_field_attributes( 'email' ); ?>/>
 
     <label for="pass1"><?php _e( 'Change Password <span>(leave blank for no change)</span>', 'buddypress' ); ?></label>
-    <input type="password" name="pass1" id="pass1" size="16" value="" class="settings-input small password-entry" /> &nbsp;<?php _e( 'New Password', 'buddypress' ); ?><br />
+    <input type="password" name="pass1" id="pass1" size="16" value="" class="settings-input small password-entry" <?php bp_form_field_attributes( 'password' ); ?>/> &nbsp;<?php _e( 'New Password', 'buddypress' ); ?><br />
     <div id="pass-strength-result"></div>
-    <input type="password" name="pass2" id="pass2" size="16" value="" class="settings-input small password-entry-confirm" /> &nbsp;<?php _e( 'Repeat New Password', 'buddypress' ); ?>
+    <input type="password" name="pass2" id="pass2" size="16" value="" class="settings-input small password-entry-confirm" <?php bp_form_field_attributes( 'password' ); ?>/> &nbsp;<?php _e( 'Repeat New Password', 'buddypress' ); ?>
 
     <?php do_action( 'bp_core_general_settings_before_submit' ); ?>

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

@@ -3625 +3625 @@
          * @param string $value Class name for the current class instance.
          */
-        $r    = (array) apply_filters( 'bp_xprofile_field_edit_html_elements', $r, get_class( $this ) );
-
-        foreach ( $r as $name => $value ) {
-            $html .= sprintf( '%s="%s" ', sanitize_key( $name ), esc_attr( $value ) );
-        }
-
-        return $html;
+        $r = (array) apply_filters( 'bp_xprofile_field_edit_html_elements', $r, get_class( $this ) );
+
+        return bp_get_form_field_attributes( sanitize_key( bp_get_the_profile_field_name() ), $r );
     }
 }