Changeset 6433 for trunk/src/includes/common/template.php

Timestamp:

05/26/2017 09:50:36 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Forms: Introduce bbp_tab_index_attribute() helpers to handle tabindex attribute output.

Note that these functions are used but normally their output is suppressed, because overriding the browser's natural tabindex order is impolite, and may introduce more issues than it actually fixes.

(Also includes some surrounding code clean-up.)

File:

• trunk/src/includes/common/template.php (modified) (2 diffs)

trunk/src/includes/common/template.php

@@ -1398 +1398 @@
 
         return apply_filters( 'bbp_get_tab_index', (int) $bbp->tab_index );
+    }
+
+/**
+ * Output a "tabindex" attribute for an element, if an index was passed.
+ *
+ * This helper function is in use, but it is generally considered impolite to
+ * override the "tabindex" attribute beyond what the browser naturally assigns.
+ *
+ * Most internal usages pass `false` which results in no attribute being used.
+ *
+ * @since 2.6.0 bbPress (r6424)
+ *
+ * @param mixed $tab False to skip, any integer to use
+ */
+function bbp_tab_index_attribute( $tab = false ) {
+    echo bbp_get_tab_index_attribute( $tab );
+}
+
+    /**
+     * Return a "tabindex" attribute for an element, if an index was passed.
+     *
+     * This helper function is in use, but it is generally considered impolite to
+     * override the "tabindex" attribute beyond what the browser naturally assigns.
+     *
+     * Most internal usages pass `false` which results in no attribute being used.
+     *
+     * @since 2.6.0 bbPress (r6424)
+     *
+     * @param mixed $tab False to skip, any integer to use
+     *
+     * @return string
+     */
+    function bbp_get_tab_index_attribute( $tab = false ) {
+
+        // Get attribute
+        $attr = is_numeric( $tab )
+            ? ' tabindex="' . (int) $tab . '"'
+            : '';
+
+        // Filter & return
+        return apply_filters( 'bbp_get_tab_index_attribute', $attr, $tab );
     }
 
@@ -1884 +1925 @@
          * escaping the editable output, mucking up existing content.
          */
-        else :
-
-            // Setup the tab index attribute
-            $tab = ! empty( $r['tab'] ) ? ' tabindex="' . intval( $r['tab'] ) . '"' : ''; ?>
-
-            <textarea id="bbp_<?php echo esc_attr( $r['context'] ); ?>_content" class="<?php echo esc_attr( $r['editor_class'] ); ?>" name="bbp_<?php echo esc_attr( $r['context'] ); ?>_content" cols="60" rows="<?php echo esc_attr( $r['textarea_rows'] ); ?>" <?php echo $tab; ?>><?php echo $post_content; ?></textarea>
+        else : ?>
+
+            <textarea id="bbp_<?php echo esc_attr( $r['context'] ); ?>_content" class="<?php echo esc_attr( $r['editor_class'] ); ?>" name="bbp_<?php echo esc_attr( $r['context'] ); ?>_content" cols="60" rows="<?php echo esc_attr( $r['textarea_rows'] ); ?>" <?php bbp_tab_index_attribute( $r['tab'] ); ?>><?php echo $post_content; ?></textarea>
 
         <?php endif;