Add support for multi-column list fields (#5)

Author: Zoltan Balogh <reddomester@gmail.com>

Add support for multi-column list fields

Co-authored-by: Matt Mirus <matt@mattmirus.com>

Author: reddo

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0 / 2019-09-24
+
+- Add support for multiple columns using List field type (thanks @reddo!)
+
 ## 1.0.5 / 2019-08-28
 
 - Update dependencies to fix vulnerabilities

README.md

@@ -7,7 +7,11 @@
 
 This plugin allows you to add custom data attributes to Gravity Forms fields.
 
-It should work with all of the Standard field types and any of the Advanced field types that only have one input field (e.g., Email but not Address).
+It should work with:
+
+- all of the Standard field types
+- any of the Advanced field types that only have one input field (e.g., Email but not Address)
+- the List advanced field type, including with multiple columns (thanks @reddo!).
 
 For fields with choices, such as checkboxes, you can assign separate values for each data attribute for each choice (the UI for this is ugly right now 🤷‍).
 

app/frontend.php

@@ -8,10 +8,16 @@ function dataAttrNamesToArray($attrs)
     return preg_split("/\r\n|\n|\r/", $attrs);
 }
 
+// test is the field has data attributes
+function fieldHasDataAttributes($field)
+{
+    return property_exists($field, 'enableDataAttrsField') && $field->enableDataAttrsField;
+}
+
 // Add data attributes to inputs that don't have multiple choices
 add_filter('gform_field_content', function ($content, $field, $value, $lead_id, $form_id) {
-    // Bail if: in the admin, the field has choices, or the field doesn't have data attributes enabled
-    if (is_admin() || !empty($field->choices) || !property_exists($field, 'enableDataAttrsField') || !$field->enableDataAttrsField) {
+    // Bail if: in the admin, no data attributes, or the field has choices
+    if (is_admin() || !fieldHasDataAttributes($field) || !empty($field->choices)) {
         return $content;
     }
 
@@ -38,8 +44,8 @@ function dataAttrNamesToArray($attrs)
 
 // Add data attributes to inputs that have multiple choices (checkboxes, drop downs, etc.)
 add_filter('gform_field_choice_markup_pre_render', function ($choice_markup, $choice, $field, $value) {
-    // Bail if: in the admin or the field doesn't have data attributes enabled
-    if (is_admin() || !property_exists($field, 'enableDataAttrsField') || !$field->enableDataAttrsField) {
+    // Bail if: in the admin or no data attributes
+    if (is_admin() || !fieldHasDataAttributes($field)) {
         return $choice_markup;
     }
 
@@ -72,3 +78,39 @@ function dataAttrNamesToArray($attrs)
 
     return $choice_markup;
 }, 10, 4);
+
+// Add data attributes to multi-column list fields
+add_filter('gform_column_input_content', function ($input, $input_info, $field, $text) {
+    // Bail if: in the admin, no data attributes, or the field isn't using multiple columns
+    if (is_admin() || !fieldHasDataAttributes($field) || empty($field->choices)) {
+        return $input;
+    }
+
+    $attrs = dataAttrNamesToArray($field->dataAttrsField);
+
+    $attrHtml = '';
+
+    foreach ($attrs as $attr) {
+        $item = null;
+        foreach ($field->choices as $choice) {
+            if ($text == $choice['text']) {
+                $item = $choice;
+                break;
+            }
+        }
+
+        // skip if not set
+        if (!array_key_exists($attr, $item)) {
+            continue;
+        }
+
+        $value = $item[$attr];
+        $attrHtml .= " data-{$attr}='{$value}'";
+    }
+
+    if ($attrHtml) {
+        $input = str_replace(' name=', "$attrHtml name=", $input);
+    }
+
+    return $input;
+}, 10, 5);

gravity-forms-data-attributes.php

@@ -5,7 +5,7 @@
 Description: Add custom data attributes to Gravity Forms fields.
 Author: Matt Mirus
 Author URI: https://github.com/mmirus
-Version: 1.0.5
+Version: 1.1.0
 GitHub Plugin URI: https://github.com/mmirus/gravity-forms-data-attributes
  */
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gravity-forms-data-attributes",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Add custom data attributes to Gravity Forms fields.",
   "private": true,
   "repository": "git@github.com:mmirus/gravity-forms-data-attributes.git",