Add a new field

Add a new field button

Basic

This will add the field to the top section of the fields.

add_filter('frm_available_fields', 'add_basic_field');
function add_basic_field($fields){
	$fields['signature'] = __('Signature'); // the key for the field and the label
	return $fields;
}

Pro

This will add a field to the advanced section of fields.

add_filter('frm_pro_available_fields', 'add_pro_field');
function add_pro_field($fields){
	$fields['signature'] = __('Signature'); // the key for the field and the label
	return $fields;
}

Set default options

Set default settings like the field name for your new field.

add_filter('frm_before_field_created', 'set_my_field_defaults');
function set_my_field_defaults($field_data){
    if ( $field_data['type'] == 'signature' ) {
        $field_data['name'] = 'Signature';

        $defaults = array(
            'size' => 400, 'max' => 150,
            'label1' => 'Draw It',
        );

        foreach ( $defaults as $k => $v ) {
            $field_data['field_options'][ $k ] = $v;
        }
    }

    return $field_data;
}

Show the field in the builder page

add_action('frm_display_added_fields', 'show_the_admin_field');
function show_the_admin_field($field){
    if ( $field['type'] != 'signature' ) {
        return;
    }

    $field_name = 'item_meta['. $field['id'] .']';
    ?>
	
	<div class="frm_html_field_placeholder">
	<div class="howto button-secondary frm_html_field">This is a placeholder for your signature field. <br/>View your form to see it in action.</div>
	</div> <?php
}

Add options to your field

This will add extra options to the field options box for your field.

add_action('frm_field_options_form', 'my_field_options_form', 10, 3);
function my_field_options_form($field, $display, $values){
  if ( $field['type'] != 'signature' ) {
    return;
  }
  
  $defaults = array(
    'size' => 400, 'max' => 150,
    'label1' => 'Draw It',
  );

  foreach($defaults as $k => $v){
    if ( ! isset($field[$k]) ) {
      $field[$k] = $v;
    }
  }
?>
<tr><td><label>Field Size</label></td>
    <td>
    <input type="text" name="field_options[size_<?php echo $field['id'] ?>]" value="<?php echo esc_attr($field['size']); ?>" size="5" /> <span class="howto">pixels wide</span>

    <input type="text" name="field_options[max_<?php echo $field['id'] ?>]" value="<?php echo esc_attr($field['max']); ?>" size="5" /> <span class="howto">pixels high</span>
    </td>
</tr>

<tr><td><label>Signature Options</label></td>
    <td>
    <label for="label1_<?php echo $field['id'] ?>" class="howto">Draw It Label</label>
    <input type="text" name="field_options[label1_<?php echo $field['id'] ?>]" value="<?php echo esc_attr($field['label1']); ?>" class="frm_long_input" id="label1_<?php echo $field['id'] ?>"  />
    </td>
</tr>
<?php
}

Save field options

Format the posted field options so they save correctly.

add_filter( 'frm_update_field_options', 'update_field_options', 10, 3 );
    function update_field_options( $field_options, $field, $values ) {
        if($field->type != 'signature')
            return $field_options;
            
        $defaults = array(
            'label1' => __('Draw It', 'formidable'),
            'label2' => __('Type It', 'formidable'),
            'label3' => __('Clear', 'formidable'),
        );
        
        foreach ($defaults as $opt => $default)
            $field_options[ $opt ] = isset( $values['field_options'][ $opt . '_' . $field->id ] ) ? $values['field_options'][ $opt . '_' . $field->id ] : $default;
            
        return $field_options;
    }

Show the field in your form

Control the output for this field in your form. Note: After adding this hook, the value submitted in this field should save correctly with the rest of the entry. If it does not, something is probably incorrect in this hook.

add_action('frm_form_fields', 'show_my_front_field', 10, 3);
function show_my_front_field( $field, $field_name, $atts ) {
  if ( $field['type'] != 'signature' ) {
    return;
  }
  $field['value'] = stripslashes_deep($field['value']);
?>
<input type="text" id="<?php echo esc_attr( $atts['html_id'] ) ?>" name="<?php echo esc_attr( $field_name ) ?>" value="<?php echo esc_attr($field['value']) ?>" />
<?php
}

Add custom validation

Return errors if the field is required and is left blank. Note: this validation is already handled by Formidable. The code below is just an example.

add_filter( 'frm_validate_field_entry', 'validate_my_field', 9, 3 );
function validate_my_field( $errors, $field, $value ) {
    if ( $field->type != 'signature' || $field->required != '1' || isset( $errors['field'. $field->id] ) ) {
        return $errors;
    }

	// Return an error if the field is required and empty
    if ( empty( $value ) || ( empty( $value['output'] ) && empty( $value['typed'] ) ) ) {
        if ( method_exists( 'FrmProFieldsHelper', 'is_field_hidden' ) ) {
            $hidden = FrmProFieldsHelper::is_field_hidden( $field, $_POST );
        } else {
            $hidden = false;
        }

        if ( ! $hidden ) {
            global $frm_settings;
            $errors['field'. $field->id] = ( ! isset( $field->field_options['blank'] ) || empty( $field->field_options['blank'] ) ) ? $frm_settings->blank_msg : $field->field_options['blank'];
        }
    }

    return $errors;
}

Modify value displayed with shortcode

This hook allows you to control the value displayed when the field ID shortcode is used.

add_filter( 'frmpro_fields_replace_shortcodes', 'display_field_value_with_shortcode', 10, 4 );
function display_field_value_with_shortcode( $value, $tag, $atts, $field ) {
    if ( $field->type != 'signature' ) {
        return $value;
    }

    $value = '<div class="my_custom_class">' . $value . '</div>';
	
    return $value;
}

Modify value displayed when viewing entry

Use the code below to modify the displayed value when you are viewing an entry on the back-end.

add_filter( 'frm_display_value', 'display_my_field_value', 10, 3 );
function display_my_field_value( $value, $field, $atts ) {
    if ( $field->type != 'signature' || empty( $value ) ) {
        return $value;
    }
	
	$value = '<div style="color:blue;">' . $value . '</div>';
	
	return $value;
}