class = $this->is_pro ? 'upgrade-modal' : '';
$this->form_id = isset( $_GET['form_id'] ) ? absint( $_GET['form_id'] ) : false; // phpcs:ignore WordPress.Security.NonceVerification
// Init hooks.
$this->init_hooks();
// Hooks.
add_action( 'everest_forms_builder_fields_options_' . $this->type, array( $this, 'field_options' ) );
add_action( 'everest_forms_builder_fields_preview_' . $this->type, array( $this, 'field_preview' ) );
add_action( 'wp_ajax_everest_forms_new_field_' . $this->type, array( $this, 'field_new' ) );
add_action( 'everest_forms_display_field_' . $this->type, array( $this, 'field_display' ), 10, 3 );
add_action( 'everest_forms_display_edit_form_field_' . $this->type, array( $this, 'edit_form_field_display' ), 10, 3 );
add_action( 'everest_forms_process_validate_' . $this->type, array( $this, 'validate' ), 10, 3 );
add_action( 'everest_forms_process_format_' . $this->type, array( $this, 'format' ), 10, 4 );
add_filter( 'everest_forms_field_properties', array( $this, 'field_prefill_value_property' ), 10, 3 );
add_filter( 'everest_forms_field_exporter_' . $this->type, array( $this, 'field_exporter' ) );
}
/**
* Hook in tabs.
*/
public function init_hooks() {}
/**
* Prefill field value with either fallback or dynamic data.
* Needs to be public (although internal) to be used in WordPress hooks.
*
* @since 1.6.5
*
* @param array $properties Field properties.
* @param array $field Current field specific data.
* @param array $form_data Prepared form data/settings.
*
* @return array Modified field properties.
*/
public function field_prefill_value_property( $properties, $field, $form_data ) {
// Process only for current field.
if ( $this->type !== $field['type'] ) {
return $properties;
}
// Set the form data, so we can reuse it later, even on front-end.
$this->form_data = $form_data;
return $properties;
}
/**
* Get the form fields after they are initialized.
*
* @return array of options
*/
public function get_field_settings() {
return apply_filters( 'everest_forms_get_field_settings_' . $this->type, $this->settings );
}
/**
* Output form fields options.
*
* Loops though the field options array and outputs each field.
*
* @param array $field Field data.
*/
public function field_options( $field ) {
$settings = $this->get_field_settings();
foreach ( $settings as $option_key => $option ) {
$this->field_option(
$option_key,
$field,
array(
'markup' => 'open',
)
);
if ( ! empty( $option['field_options'] ) ) {
foreach ( $option['field_options'] as $option_name ) {
$this->field_option( $option_name, $field );
}
}
$this->field_option(
$option_key,
$field,
array(
'markup' => 'close',
)
);
}
}
/**
* Field preview inside the builder.
*
* @since 1.0.0
*
* @param array $field Field data and settings.
*/
public function field_preview( $field ) {}
/**
* Helper function to create field option elements.
*
* Field option elements are pieces that help create a field option.
* They are used to quickly build field options.
*
* @since 1.0.0
*
* @param string $option Field option to render.
* @param array $field Field data and settings.
* @param array $args Field preview arguments.
* @param boolean $echo Print or return the value. Print by default.
*
* @return mixed echo or return string
*/
public function field_element( $option, $field, $args = array(), $echo = true ) {
$id = (string) $field['id'];
$class = ! empty( $args['class'] ) && is_string( $args['class'] ) ? esc_attr( $args['class'] ) : '';
$slug = ! empty( $args['slug'] ) ? sanitize_title( $args['slug'] ) : '';
$data = '';
$output = '';
if ( ! empty( $args['data'] ) ) {
foreach ( $args['data'] as $key => $val ) {
if ( is_array( $val ) ) {
$val = wp_json_encode( $val );
}
$data .= ' data-' . $key . '=\'' . $val . '\'';
}
}
// BW compat for number attrs.
if ( ! empty( $args['min'] ) ) {
$args['attrs']['min'] = esc_attr( $args['min'] );
unset( $args['min'] );
}
if ( ! empty( $args['max'] ) ) {
$args['attrs']['max'] = esc_attr( $args['max'] );
unset( $args['min'] );
}
if ( ! empty( $args['required'] ) && $args['required'] ) {
$args['attrs']['required'] = 'required';
unset( $args['required'] );
}
if ( ! empty( $args['attrs'] ) ) {
foreach ( $args['attrs'] as $arg_key => $val ) {
if ( is_array( $val ) ) {
$val = wp_json_encode( $val );
}
$data .= $arg_key . '=\'' . $val . '\'';
}
}
switch ( $option ) {
// Row.
case 'row':
$output = sprintf( '%s
', $slug, $class, $id, $slug, $id, $data, $args['content'] );
break;
// Icon.
case 'icon':
$element_tooltip = isset( $args['tooltip'] ) ? $args['tooltip'] : 'Edit Label';
$icon = isset( $args['icon'] ) ? $args['icon'] : 'dashicons-edit';
$output .= sprintf( ' ', esc_attr( $icon ), $class, esc_attr( $element_tooltip ), $data );
break;
// Label.
case 'label':
$output = sprintf( '';
break;
// Text input.
case 'text':
$type = ! empty( $args['type'] ) ? esc_attr( $args['type'] ) : 'text';
$placeholder = ! empty( $args['placeholder'] ) ? esc_attr( $args['placeholder'] ) : '';
$before = ! empty( $args['before'] ) ? '' . esc_html( $args['before'] ) . '' : '';
if ( ! empty( $before ) ) {
$class .= ' has-before';
}
$output = sprintf( '%s', $before, $type, $class, $id, $slug, $id, $slug, esc_attr( $args['value'] ), $placeholder, $data );
break;
// Textarea.
case 'textarea':
$rows = ! empty( $args['rows'] ) ? (int) $args['rows'] : '3';
$output = sprintf( '', $class, $id, $slug, $id, $slug, $rows, $data, $args['value'] );
break;
// Checkbox.
case 'checkbox':
$checked = checked( '1', $args['value'], false );
$output = sprintf( '', $class, $id, $slug, $id, $slug, $checked, $data );
$output .= sprintf( '';
break;
// Toggle.
case 'toggle':
$checked = checked( '1', $args['value'], false );
$icon = $args['value'] ? 'fa-toggle-on' : 'fa-toggle-off';
$cls = $args['value'] ? 'everest-forms-on' : 'everest-forms-off';
$status = $args['value'] ? __( 'On', 'everest-forms' ) : __( 'Off', 'everest-forms' );
$output = sprintf( ' %s', $cls, $icon, $status );
$output .= sprintf( '', $class, $id, $slug, $id, $slug, $checked, $data );
break;
// Select.
case 'select':
$options = $args['options'];
$value = isset( $args['value'] ) ? $args['value'] : '';
$output = sprintf( '';
break;
// Radio.
case 'radio':
$options = $args['options'];
$default = isset( $args['default'] ) ? $args['default'] : '';
$output = '', esc_attr( $args['tooltip'] ) );
} else {
$output .= '';
}
$output .= '';
foreach ( $options as $key => $option ) {
$output .= '- ';
$output .= sprintf( '', $class, $id, $slug, $key, $key, $id, $slug, $data, checked( $key, $default, false ), $option );
$output .= '
';
}
$output .= '
';
break;
}
if ( $echo ) {
echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
return $output;
}
}
/**
* Helper function to create common field options that are used frequently.
*
* @since 1.0.0
*
* @param string $option Option.
* @param array $field Field data.
* @param array $args Arguments.
* @param boolean $echo True to echo.
*
* @return mixed echo or return string
*/
public function field_option( $option, $field, $args = array(), $echo = true ) {
$output = '';
switch ( $option ) {
/**
* Basic Fields.
*/
/*
* Basic Options markup.
*/
case 'basic-options':
$markup = ! empty( $args['markup'] ) ? $args['markup'] : 'open';
$class = ! empty( $args['class'] ) ? esc_html( $args['class'] ) : '';
if ( 'open' === $markup ) {
$output = sprintf( '';
}
break;
/*
* Field Label.
*/
case 'label':
$value = ! empty( $field['label'] ) ? esc_attr( $field['label'] ) : '';
$tooltip = esc_html__( 'Enter text for the form field label. This is recommended and can be hidden in the Advanced Settings.', 'everest-forms' );
$output = $this->field_element(
'label',
$field,
array(
'slug' => 'label',
'value' => esc_html__( 'Label', 'everest-forms' ),
'tooltip' => $tooltip,
),
false
);
$output .= $this->field_element(
'text',
$field,
array(
'slug' => 'label',
'value' => $value,
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'label',
'content' => $output,
),
false
);
break;
/*
* Field Meta.
*/
case 'meta':
$value = ! empty( $field['meta-key'] ) ? esc_attr( $field['meta-key'] ) : evf_get_meta_key_field_option( $field );
$tooltip = esc_html__( 'Enter meta key to be stored in database.', 'everest-forms' );
$output = $this->field_element(
'label',
$field,
array(
'slug' => 'meta-key',
'value' => esc_html__( 'Meta Key', 'everest-forms' ),
'tooltip' => $tooltip,
),
false
);
$output .= $this->field_element(
'text',
$field,
array(
'slug' => 'meta-key',
'class' => 'evf-input-meta-key',
'value' => $value,
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'meta-key',
'content' => $output,
),
false
);
break;
/*
* Field Description.
*/
case 'description':
$value = ! empty( $field['description'] ) ? esc_attr( $field['description'] ) : '';
$tooltip = esc_html__( 'Enter text for the form field description.', 'everest-forms' );
$output = $this->field_element(
'label',
$field,
array(
'slug' => 'description',
'value' => esc_html__( 'Description', 'everest-forms' ),
'tooltip' => $tooltip,
),
false
);
$output .= $this->field_element(
'textarea',
$field,
array(
'slug' => 'description',
'value' => $value,
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'description',
'content' => $output,
),
false
);
break;
/*
* Field Required toggle.
*/
case 'required':
$default = ! empty( $args['default'] ) ? $args['default'] : '0';
$value = isset( $field['required'] ) ? $field['required'] : $default;
$tooltip = esc_html__( 'Check this option to mark the field required. A form will not submit unless all required fields are provided.', 'everest-forms' );
$output = $this->field_element(
'checkbox',
$field,
array(
'slug' => 'required',
'value' => $value,
'desc' => esc_html__( 'Required', 'everest-forms' ),
'tooltip' => $tooltip,
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'required',
'content' => $output,
),
false
);
break;
/*
* Required Field Message.
*/
case 'required_field_message':
$has_sub_fields = false;
$sub_fields = array();
$required_validation = get_option( 'everest_forms_required_validation' );
if ( in_array( $field['type'], array( 'number', 'email', 'url', 'phone' ), true ) ) {
$required_validation = get_option( 'everest_forms_' . $field['type'] . '_validation' );
}
if ( 'likert' === $field['type'] ) {
$has_sub_fields = true;
$likert_rows = isset( $field['likert_rows'] ) ? $field['likert_rows'] : array();
foreach ( $likert_rows as $row_number => $row_label ) {
$row_slug = 'required-field-message-' . $row_number;
$sub_fields[ $row_slug ] = array(
'label' => array(
'value' => $row_label,
'tooltip' => esc_html__( 'Enter a message to show for this row if it\'s required.', 'everest-forms' ),
),
'text' => array(
'value' => isset( $field[ $row_slug ] ) ? esc_attr( $field[ $row_slug ] ) : esc_attr( $required_validation ),
),
);
}
} elseif ( 'address' === $field['type'] ) {
$has_sub_fields = true;
$sub_fields = array(
'required-field-message-address1' => array(
'label' => array(
'value' => esc_html__( 'Address Line 1', 'everest-forms' ),
'tooltip' => esc_html__( 'Enter a message to show for Address Line 1 if it\'s required.', 'everest-forms' ),
),
'text' => array(
'value' => isset( $field['required-field-message-address1'] ) ? esc_attr( $field['required-field-message-address1'] ) : esc_attr( $required_validation ),
),
),
'required-field-message-city' => array(
'label' => array(
'value' => esc_html__( 'City', 'everest-forms' ),
'tooltip' => esc_html__( 'Enter a message to show for City if it\'s required.', 'everest-forms' ),
),
'text' => array(
'value' => isset( $field['required-field-message-city'] ) ? esc_attr( $field['required-field-message-city'] ) : esc_attr( $required_validation ),
),
),
'required-field-message-state' => array(
'label' => array(
'value' => esc_html__( 'State / Province / Region', 'everest-forms' ),
'tooltip' => esc_html__( 'Enter a message to show for State/Province/Region if it\'s required.', 'everest-forms' ),
),
'text' => array(
'value' => isset( $field['required-field-message-state'] ) ? esc_attr( $field['required-field-message-state'] ) : esc_attr( $required_validation ),
),
),
'required-field-message-postal' => array(
'label' => array(
'value' => esc_html__( 'Zip / Postal Code', 'everest-forms' ),
'tooltip' => esc_html__( 'Enter a message to show for Zip/Postal Code if it\'s required.', 'everest-forms' ),
),
'text' => array(
'value' => isset( $field['required-field-message-postal'] ) ? esc_attr( $field['required-field-message-postal'] ) : esc_attr( $required_validation ),
),
),
'required-field-message-country' => array(
'label' => array(
'value' => esc_html__( 'Country', 'everest-forms' ),
'tooltip' => esc_html__( 'Enter a message to show for Country if it\'s required.', 'everest-forms' ),
),
'text' => array(
'value' => isset( $field['required-field-message-country'] ) ? esc_attr( $field['required-field-message-country'] ) : esc_attr( $required_validation ),
),
),
);
}
if ( true === $has_sub_fields ) {
$sub_field_output_array = array();
foreach ( $sub_fields as $sub_field_slug => $sub_field_data ) {
$value = isset( $field['required-field-message'] ) ? esc_attr( $field['required-field-message'] ) : esc_attr( $required_validation );
$tooltip = esc_html__( 'Enter a message to show for this field if it\'s required.', 'everest-forms' );
$output = $this->field_element(
'label',
$field,
array(
'slug' => $sub_field_slug,
'value' => $sub_field_data['label']['value'],
'tooltip' => $sub_field_data['label']['tooltip'],
),
false
);
$output .= $this->field_element(
'text',
$field,
array(
'slug' => $sub_field_slug,
'value' => $sub_field_data['text']['value'],
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => $sub_field_slug,
'content' => $output,
),
false
);
$sub_field_output_array[] = $output;
}
$output = implode( '', $sub_field_output_array );
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'required-field-message',
'class' => isset( $field['required'] ) ? '' : 'hidden',
'content' => $output,
),
false
);
} else {
$value = isset( $field['required-field-message'] ) ? esc_attr( $field['required-field-message'] ) : esc_attr( $required_validation );
$tooltip = esc_html__( 'Enter a message to show for this field if it\'s required.', 'everest-forms' );
$output = $this->field_element(
'label',
$field,
array(
'slug' => 'required-field-message',
'value' => esc_html__( 'Required Field Message', 'everest-forms' ),
'tooltip' => $tooltip,
),
false
);
$output .= $this->field_element(
'text',
$field,
array(
'slug' => 'required-field-message',
'value' => $value,
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'required-field-message',
'class' => isset( $field['required'] ) ? '' : 'hidden',
'content' => $output,
),
false
);
}
break;
/*
* Code Block.
*/
case 'code':
$value = ! empty( $field['code'] ) ? esc_attr( $field['code'] ) : '';
$tooltip = esc_html__( 'Enter code for the form field.', 'everest-forms' );
$output = $this->field_element(
'label',
$field,
array(
'slug' => 'code',
'value' => esc_html__( 'Code', 'everest-forms' ),
'tooltip' => $tooltip,
),
false
);
$output .= $this->field_element(
'textarea',
$field,
array(
'slug' => 'code',
'value' => $value,
),
false
);
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'code',
'content' => $output,
),
false
);
break;
/*
* Choices.
*/
case 'choices':
$class = array();
$label = ! empty( $args['label'] ) ? esc_html( $args['label'] ) : esc_html__( 'Choices', 'everest-forms' );
$choices = ! empty( $field['choices'] ) ? $field['choices'] : $this->defaults;
$input_type = in_array( $field['type'], array( 'radio', 'select', 'payment-multiple' ), true ) ? 'radio' : 'checkbox';
if ( ! empty( $field['show_values'] ) ) {
$class[] = 'show-values';
}
if ( ! empty( $field['choices_images'] ) ) {
$class[] = 'show-images';
}
if ( ! empty( $field['multiple_choices'] ) ) {
$input_type = 'checkbox';
}
// Add bulk options toggle handle.
$bulk_add_enabled = apply_filters( 'evf_bulk_add_enabled', true );
$licensed = ( false === evf_get_license_plan() ) ? false : true;
$upgradable_feature_class = ( true === $licensed ) ? '' : 'evf-upgradable-feature';
$bulk_options_toggle_handle = sprintf( '%s', esc_attr( $upgradable_feature_class ), esc_html__( 'Bulk Add', 'everest-forms' ) );
// Field label.
$field_label = $this->field_element(
'label',
$field,
array(
'slug' => 'choices',
'value' => $label,
'tooltip' => esc_html__( 'Add choices for the form field.', 'everest-forms' ),
'after_tooltip' => $bulk_options_toggle_handle, // @todo Bulk import and export for choices.
)
);
$field_content = '';
if ( true === $bulk_add_enabled && true === $licensed ) {
$field_content .= $this->field_option(
'add_bulk_options',
$field,
array(
'class' => 'everest-forms-hidden',
)
);
}
if ( 'select' === $field['type'] ) {
$selection_btn = array();
$selection_types = array(
'single' => array(
'type' => 'radio',
'label' => esc_html__( 'Single Selection', 'everest-forms' ),
),
'multiple' => array(
'type' => 'checkbox',
'label' => esc_html__( 'Multiple Selection', 'everest-forms' ),
),
);
$active_type = ! empty( $field['multiple_choices'] ) && '1' === $field['multiple_choices'] ? 'multiple' : 'single';
foreach ( $selection_types as $key => $selection_type ) {
$selection_btn[ $key ] = '' . esc_html( $selection_type['label'] ) . '';
}
$field_content .= sprintf(
'%3$s
',
esc_attr( $field['id'] ),
! empty( $field['multiple_choices'] ) && '1' === $field['multiple_choices'] ? 1 : 0,
implode( '', $selection_btn )
);
}
// Field contents.
$field_content .= sprintf(
'',
max( array_keys( $choices ) ) + 1,
evf_sanitize_classes( $class, true ),
$field['id'],
$this->type
);
foreach ( $choices as $key => $choice ) {
$default = ! empty( $choice['default'] ) ? $choice['default'] : '';
$name = sprintf( 'form_fields[%s][choices][%s]', $field['id'], $key );
$image = ! empty( $choice['image'] ) ? $choice['image'] : '';
// BW compatibility for value in payment fields.
if ( ! empty( $field['amount'][ $key ]['value'] ) ) {
$choice['value'] = evf_format_amount( evf_sanitize_amount( $field['amount'][ $key ]['value'] ) );
}
$field_content .= sprintf( '- ', absint( $key ) );
$field_content .= '';
$field_content .= sprintf( '', $input_type, $name, checked( '1', $default, false ) );
$field_content .= '
';
$field_content .= sprintf( '', $name, esc_attr( $choice['label'] ), absint( $key ) );
if ( in_array( $field['type'], array( 'payment-multiple', 'payment-checkbox' ), true ) ) {
$field_content .= sprintf( '', $name, esc_attr( $choice['value'] ), evf_format_amount( 0 ) );
} else {
$field_content .= sprintf( '', $name, esc_attr( $choice['value'] ) );
}
$field_content .= '
';
$field_content .= '';
$field_content .= '';
$field_content .= '';
$field_content .= ' ';
}
$field_content .= '
';
// Final field output.
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'choices',
'content' => $field_label . $field_content,
),
false
);
break;
/*
* Choices Images.
*/
case 'choices_images':
$field_content = sprintf(
'',
empty( $field['choices_images'] ) ? ' hidden' : '',
esc_html__( 'For best results, images should be square and at least 200 × 160 pixels or smaller.', 'everest-forms' )
);
$field_content .= $this->field_element(
'checkbox',
$field,
array(
'slug' => 'choices_images',
'value' => isset( $field['choices_images'] ) ? '1' : '0',
'desc' => esc_html__( 'Use image choices', 'everest-forms' ),
'tooltip' => esc_html__( 'Check this option to enable using images with the choices.', 'everest-forms' ),
),
false
);
// Final field output.
$output = $this->field_element(
'row',
$field,
array(
'slug' => 'choices_images',
'content' => $field_content,
),
false
);
break;
/**
* Add bulk options.
*/
case 'add_bulk_options':
$class = ! empty( $args['class'] ) ? esc_attr( $args['class'] ) : '';
$label = ! empty( $args['label'] ) ? esc_html( $args['label'] ) : esc_html__( 'Add Bulk Options', 'everest-forms' );
// Field label.
$field_label = $this->field_element(
'label',
$field,
array(
'slug' => 'add_bulk_options',
'value' => $label,
'tooltip' => esc_html__( 'Add multiple options at once.', 'everest-forms' ),
'after_tooltip' => sprintf( '%s', esc_html__( 'Presets', 'everest-forms' ) ),
),
false
);
// Preset contents.
$presets = array(
array(
'label' => esc_html__( 'Months', 'everest-forms' ),
'class' => 'evf-options-preset-months',
'options' => array(
esc_html__( 'January', 'everest-forms' ),
esc_html__( 'February', 'everest-forms' ),
esc_html__( 'March', 'everest-forms' ),
esc_html__( 'April', 'everest-forms' ),
esc_html__( 'May', 'everest-forms' ),
esc_html__( 'June', 'everest-forms' ),
esc_html__( 'July', 'everest-forms' ),
esc_html__( 'August', 'everest-forms' ),
esc_html__( 'September', 'everest-forms' ),
esc_html__( 'October', 'everest-forms' ),
esc_html__( 'November', 'everest-forms' ),
esc_html__( 'December', 'everest-forms' ),
),
),
array(
'label' => esc_html__( 'Week Days', 'everest-forms' ),
'class' => 'evf-options-preset-week-days',
'options' => array(
esc_html__( 'Sunday', 'everest-forms' ),
esc_html__( 'Monday', 'everest-forms' ),
esc_html__( 'Tuesday', 'everest-forms' ),
esc_html__( 'Wednesday', 'everest-forms' ),
esc_html__( 'Thursday', 'everest-forms' ),
esc_html__( 'Friday', 'everest-forms' ),
esc_html__( 'Saturday', 'everest-forms' ),
),
),
array(
'label' => esc_html__( 'Countries', 'everest-forms' ),
'class' => 'evf-options-preset-countries',
'options' => array_values( evf_get_countries() ),
),
array(
'label' => esc_html__( 'Countries Postal Code', 'everest-forms' ),
'class' => 'evf-options-preset-countries-postal-code',
'options' => array_keys( evf_get_countries() ),
),
array(
'label' => esc_html__( 'U.S. States', 'everest-forms' ),
'class' => 'evf-options-preset-states',
'options' => array_values( evf_get_states() ),
),
array(
'label' => esc_html__( 'U.S. States Postal Code', 'everest-forms' ),
'class' => 'evf-options-preset-states-postal-code',
'options' => array_keys( evf_get_states() ),
),
array(
'label' => esc_html__( 'Age Groups', 'everest-forms' ),
'class' => 'evf-options-preset-age-groups',
'options' => array(
esc_html__( 'Under 18', 'everest-forms' ),
esc_html__( '18-24', 'everest-forms' ),
esc_html__( '25-34', 'everest-forms' ),
esc_html__( '35-44', 'everest-forms' ),
esc_html__( '45-54', 'everest-forms' ),
esc_html__( '55-64', 'everest-forms' ),
esc_html__( '65 or Above', 'everest-forms' ),
esc_html__( 'Prefer Not to Answer', 'everest-forms' ),
),
),
array(
'label' => esc_html__( 'Satisfaction', 'everest-forms' ),
'class' => 'evf-options-preset-satisfaction',
'options' => array(
esc_html__( 'Very Satisfied', 'everest-forms' ),
esc_html__( 'Satisfied', 'everest-forms' ),
esc_html__( 'Neutral', 'everest-forms' ),
esc_html__( 'Unsatisfied', 'everest-forms' ),
esc_html__( 'Very Unsatisfied', 'everest-forms' ),
esc_html__( 'N/A', 'everest-forms' ),
),
),
array(
'label' => esc_html__( 'Importance', 'everest-forms' ),
'class' => 'evf-options-preset-importance',
'options' => array(
esc_html__( 'Very Important', 'everest-forms' ),
esc_html__( 'Important', 'everest-forms' ),
esc_html__( 'Neutral', 'everest-forms' ),
esc_html__( 'Somewhat Important', 'everest-forms' ),
esc_html__( 'Not at all Important', 'everest-forms' ),
esc_html__( 'N/A', 'everest-forms' ),
),
),
array(
'label' => esc_html__( 'Agreement', 'everest-forms' ),
'class' => 'evf-options-preset-agreement',
'options' => array(
esc_html__( 'Strongly Agree', 'everest-forms' ),
esc_html__( 'Agree', 'everest-forms' ),
esc_html__( 'Neutral', 'everest-forms' ),
esc_html__( 'Disagree', 'everest-forms' ),
esc_html__( 'Strongly Disagree', 'everest-forms' ),
esc_html__( 'N/A', 'everest-forms' ),
),
),
);
$presets_html = '';
foreach ( $presets as $preset ) {
$presets_html .= sprintf( '
', esc_attr( $preset['class'] ) );
$presets_html .= sprintf( '
%s', $preset['label'] );
$presets_html .= sprintf( '
', implode( "\n", $preset['options'] ) );
$presets_html .= '
';
}
$presets_html .= '
%s
', $class, $description );
break;
case 'choices':
$values = ! empty( $field['choices'] ) ? $field['choices'] : $this->defaults;
$choices_fields = array( 'select', 'radio', 'checkbox', 'payment-multiple', 'payment-checkbox' );
// Notify if choices source is currently empty.
if ( empty( $values ) ) {
$values = array(
'label' => esc_html__( '(empty)', 'everest-forms' ),
);
}
// Build output.
if ( ! in_array( $field['type'], $choices_fields, true ) ) {
break;
}
switch ( $field['type'] ) {
case 'checkbox':
case 'payment-checkbox':
$type = 'checkbox';
break;
case 'select':
$type = 'select';
break;
default:
$type = 'radio';
break;
}
$list_class = array( 'widefat', 'primary-input' );
$choices_images = ! empty( $field['choices_images'] );
if ( $choices_images ) {
$list_class[] = 'everest-forms-image-choices';
}
if ( ! empty( $class ) ) {
$list_class[] = $class;
}
if ( 'select' === $type ) {
$multiple = ! empty( $field['multiple_choices'] ) ? ' multiple' : '';
$placeholder = ! empty( $field['placeholder'] ) ? esc_attr( $field['placeholder'] ) : '';
$output = sprintf( '';
} else {
$output = sprintf( '', evf_sanitize_classes( $list_class, true ) );
// Individual checkbox/radio options.
foreach ( $values as $value ) {
$default = isset( $value['default'] ) ? $value['default'] : '';
$selected = checked( '1', $default, false );
$placeholder = evf()->plugin_url() . '/assets/images/everest-forms-placeholder.png';
$image_src = ! empty( $value['image'] ) ? esc_url( $value['image'] ) : $placeholder;
$item_class = array();
if ( ! empty( $value['default'] ) ) {
$item_class[] = 'everest-forms-selected';
}
if ( $choices_images ) {
$item_class[] = 'everest-forms-image-choices-item';
}
$output .= sprintf( '- ', evf_sanitize_classes( $item_class, true ) );
if ( $choices_images ) {
$output .= '';
} else {
$output .= sprintf( '%s', $type, $selected, $value['label'] );
}
$output .= '
';
}
$output .= '
';
}
break;
}
if ( $echo ) {
echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
return $output;
}
}
/**
* Create a new field in the admin AJAX editor.
*
* @since 1.0.0
*/
public function field_new() {
// Run a security check.
check_ajax_referer( 'everest_forms_field_drop', 'security' );
// Check for permissions.
if ( ! current_user_can( apply_filters( 'everest_forms_manage_cap', 'manage_options' ) ) ) {
die( esc_html__( 'You do no have permission.', 'everest-forms' ) );
}
// Check for form ID.
if ( ! isset( $_POST['form_id'] ) || empty( $_POST['form_id'] ) ) {
die( esc_html__( 'No form ID found', 'everest-forms' ) );
}
// Check for field type to add.
if ( ! isset( $_POST['field_type'] ) || empty( $_POST['field_type'] ) ) {
die( esc_html__( 'No field type found', 'everest-forms' ) );
}
// Grab field data.
$field_args = ! empty( $_POST['defaults'] ) ? (array) wp_unslash( $_POST['defaults'] ) : array(); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$field_type = esc_attr( wp_unslash( $_POST['field_type'] ) ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$field_id = evf()->form->field_unique_key( wp_unslash( $_POST['form_id'] ) ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$field = array(
'id' => $field_id,
'type' => $field_type,
'label' => $this->name,
'description' => '',
);
$field = wp_parse_args( $field_args, $field );
$field = apply_filters( 'everest_forms_field_new_default', $field );
$field_required = apply_filters( 'everest_forms_field_new_required', '', $field );
$field_class = apply_filters( 'everest_forms_field_new_class', '', $field );
// Field types that default to required.
if ( ! empty( $field_required ) ) {
$field_required = 'required';
$field['required'] = '1';
}
// Build Preview.
ob_start();
$this->field_preview( $field );
$preview = sprintf( '';
// Build Options.
$options = sprintf( '', esc_attr( $field['type'] ), $field['id'], $field['id'] );
$options .= sprintf( '', $field['id'], $field['id'] );
$options .= sprintf( '', $field['id'], esc_attr( $field['type'] ) );
ob_start();
$this->field_options( $field );
$options .= ob_get_clean();
$options .= '
';
$form_field_array = explode( '-', $field_id );
$field_id_int = absint( $form_field_array[ count( $form_field_array ) - 1 ] );
// Prepare to return compiled results.
wp_send_json_success(
array(
'form_id' => (int) $_POST['form_id'],
'field' => $field,
'preview' => $preview,
'options' => $options,
'form_field_id' => ( $field_id_int + 1 ),
)
);
}
/**
* Field display on the form front-end.
*
* @since 1.0.0
*
* @param array $field Field Data.
* @param array $field_atts Field attributes.
* @param array $form_data All Form Data.
*/
public function field_display( $field, $field_atts, $form_data ) {}
/**
* Edit form field display on the entry back-end.
*
* @since 1.7.0
*
* @param array $entry_field Entry field data.
* @param array $field Field data.
* @param array $form_data Form data and settings.
*/
public function edit_form_field_display( $entry_field, $field, $form_data ) {
$value = isset( $entry_field['value'] ) ? $entry_field['value'] : '';
if ( '' !== $value ) {
$field['properties'] = $this->get_single_field_property_value( $value, 'primary', $field['properties'], $field );
}
$this->field_display( $field, null, $form_data );
}
/**
* Get the value to prefill, based on field data and current properties.
*
* @since 1.7.0
*
* @param string $raw_value Raw Value, always a string.
* @param string $input Subfield inside the field.
* @param array $properties Field properties.
* @param array $field Field specific data.
*
* @return array Modified field properties.
*/
public function get_single_field_property_value( $raw_value, $input, $properties, $field ) {
if ( ! is_string( $raw_value ) ) {
return $properties;
}
$get_value = stripslashes( sanitize_text_field( $raw_value ) );
if ( ! empty( $field['choices'] ) && is_array( $field['choices'] ) ) {
$properties = $this->get_single_field_property_value_choices( $get_value, $properties, $field );
} else {
if (
! empty( $input ) &&
isset( $properties['inputs'][ $input ] )
) {
$properties['inputs'][ $input ]['attr']['value'] = $get_value;
// Update data attributes depending on the field type.
if ( isset( $field['type'] ) && 'range-slider' === $field['type'] ) {
$properties['inputs'][ $input ]['data']['from'] = $get_value;
}
}
}
return $properties;
}
/**
* Get the value to prefill for choices section, based on field data and current properties.
*
* @since 1.7.0
*
* @param string $get_value Requested value.
* @param array $properties Field properties.
* @param array $field Field specific data.
*
* @return array Modified field properties.
*/
protected function get_single_field_property_value_choices( $get_value, $properties, $field ) {
$default_key = null;
// For fields with normal choices, we need dafault key.
foreach ( $field['choices'] as $choice_key => $choice_arr ) {
$choice_value_key = isset( $field['show_values'] ) ? 'value' : 'label';
if (
isset( $choice_arr[ $choice_value_key ] ) &&
strtoupper( sanitize_text_field( $choice_arr[ $choice_value_key ] ) ) === strtoupper( $get_value )
) {
$default_key = $choice_key;
break;
}
}
// Redefine selected choice.
if ( null !== $default_key ) {
foreach ( $field['choices'] as $choice_key => $choice_arr ) {
if ( $choice_key === $default_key ) {
$properties['inputs'][ $choice_key ]['default'] = true;
$properties['inputs'][ $choice_key ]['container']['class'][] = 'everest-forms-selected';
break;
}
}
}
return $properties;
}
/**
* Remove all admin-defined defaults from choices-related fields only.
*
* @since 1.7.0
*
* @param array $field Field data and settings.
* @param array $properties Field Properties to be modified.
*/
protected function remove_field_choices_defaults( $field, &$properties ) {
if ( ! empty( $field['choices'] ) ) {
array_walk_recursive(
$properties['inputs'],
function ( &$value, $key ) {
if ( 'default' === $key ) {
$value = false;
}
if ( 'everest-forms-selected' === $value ) {
$value = '';
}
}
);
}
}
/**
* Display field input errors if present.
*
* @since 1.0.0
*
* @param string $key Input key.
* @param array $field Field data and settings.
*/
public function field_display_error( $key, $field ) {
// Need an error.
if ( empty( $field['properties']['error']['value'][ $key ] ) ) {
return;
}
printf(
'',
esc_attr( $field['properties']['inputs'][ $key ]['id'] ),
esc_html( $field['properties']['error']['value'][ $key ] )
);
}
/**
* Display field input sublabel if present.
*
* @since 1.0.0
*
* @param string $key Input key.
* @param string $position Sublabel position.
* @param array $field Field data and settings.
*/
public function field_display_sublabel( $key, $position, $field ) {
// Need a sublabel value.
if ( empty( $field['properties']['inputs'][ $key ]['sublabel']['value'] ) ) {
return;
}
$pos = ! empty( $field['properties']['inputs'][ $key ]['sublabel']['position'] ) ? $field['properties']['inputs'][ $key ]['sublabel']['position'] : 'after';
$hidden = ! empty( $field['properties']['inputs'][ $key ]['sublabel']['hidden'] ) ? 'everest-forms-sublabel-hide' : '';
if ( $pos !== $position ) {
return;
}
printf(
'',
esc_attr( $field['properties']['inputs'][ $key ]['id'] ),
sanitize_html_class( $pos ),
$hidden, // phpcs:ignore WordPress.Security.EscapeOutput
evf_string_translation( (int) $this->form_data['id'], $field['id'], $field['properties']['inputs'][ $key ]['sublabel']['value'], '-sublabel-' . $key ) // phpcs:ignore WordPress.Security.EscapeOutput
);
}
/**
* Validates field on form submit.
*
* @since 1.0.0
*
* @param string $field_id Field Id.
* @param array $field_submit Submitted Data.
* @param array $form_data All Form Data.
*/
public function validate( $field_id, $field_submit, $form_data ) {
$field_type = isset( $form_data['form_fields'][ $field_id ]['type'] ) ? $form_data['form_fields'][ $field_id ]['type'] : '';
$required_field = isset( $form_data['form_fields'][ $field_id ]['required'] ) ? $form_data['form_fields'][ $field_id ]['required'] : false;
$conditional_status = isset( $form_data['form_fields'][ $field_id ]['conditional_logic_status'] ) ? $form_data['form_fields'][ $field_id ]['conditional_logic_status'] : 0;
// Basic required check - If field is marked as required, check for entry data.
if ( false !== $required_field && '1' !== $conditional_status && ( empty( $field_submit ) && '0' !== $field_submit ) ) {
evf()->task->errors[ $form_data['id'] ][ $field_id ] = evf_get_required_label();
update_option( 'evf_validation_error', 'yes' );
}
// Type validations.
switch ( $field_type ) {
case 'url':
if ( ! empty( $_POST['everest_forms']['form_fields'][ $field_id ] ) && filter_var( $field_submit, FILTER_VALIDATE_URL ) === false ) { // phpcs:ignore WordPress.Security.NonceVerification
$validation_text = get_option( 'evf_' . $field_type . '_validation', esc_html__( 'Please enter a valid url', 'everest-forms' ) );
}
break;
case 'email':
if ( is_array( $field_submit ) ) {
$value = ! empty( $field_submit['primary'] ) ? $field_submit['primary'] : '';
} else {
$value = ! empty( $field_submit ) ? $field_submit : '';
}
if ( ! empty( $_POST['everest_forms']['form_fields'][ $field_id ] ) && ! is_email( $value ) ) { // phpcs:ignore WordPress.Security.NonceVerification
$validation_text = get_option( 'evf_' . $field_type . '_validation', esc_html__( 'Please enter a valid email address', 'everest-forms' ) );
}
break;
case 'number':
if ( ! empty( $_POST['everest_forms']['form_fields'][ $field_id ] ) && ! is_numeric( $field_submit ) ) { // phpcs:ignore WordPress.Security.NonceVerification
$validation_text = get_option( 'evf_' . $field_type . '_validation', esc_html__( 'Please enter a valid number', 'everest-forms' ) );
}
break;
}
if ( isset( $validation_text ) ) {
evf()->task->errors[ $form_data['id'] ][ $field_id ] = apply_filters( 'everest_forms_type_validation', $validation_text );
update_option( 'evf_validation_error', 'yes' );
}
}
/**
* Formats and sanitizes field.
*
* @since 1.0.0
*
* @param int $field_id Field ID.
* @param mixed $field_submit Submitted field value.
* @param array $form_data Form data and settings.
* @param string $meta_key Field meta key.
*/
public function format( $field_id, $field_submit, $form_data, $meta_key ) {
if ( is_array( $field_submit ) ) {
$field_submit = array_filter( $field_submit );
$field_submit = implode( "\r\n", $field_submit );
}
$name = ! empty( $form_data['form_fields'][ $field_id ]['label'] ) ? make_clickable( $form_data['form_fields'][ $field_id ]['label'] ) : '';
// Sanitize but keep line breaks.
$value = evf_sanitize_textarea_field( $field_submit );
evf()->task->form_fields[ $field_id ] = array(
'name' => $name,
'value' => $value,
'id' => $field_id,
'type' => $this->type,
'meta_key' => $meta_key,
);
}
/**
* Field with limit.
*
* @param array $field Field to check.
* @return boolean
*/
protected function field_is_limit( $field ) {
if ( in_array( $field['type'], array( 'text', 'textarea' ), true ) ) {
return isset( $field['limit_enabled'] ) && ! empty( $field['limit_count'] );
}
}
/**
* Filter callback for outputting formatted data.
*
* @param array $field Field Data.
*/
public function field_exporter( $field ) {
$export = array();
switch ( $this->type ) {
case 'radio':
case 'payment-multiple':
$value = '';
$image = ! empty( $field['value']['image'] ) ? sprintf( '
', $field['value']['image'] ) : '';
$value = ! empty( $field['value']['label'] ) ? $image . $field['value']['label'] : '';
$export = array(
'label' => ! empty( $field['value']['name'] ) ? $field['value']['name'] : ucfirst( str_replace( '_', ' ', $field['type'] ) ) . " - {$field['id']}",
'value' => ! empty( $value ) ? $value : false,
);
break;
case 'checkbox':
case 'payment-checkbox':
$value = array();
if ( count( $field['value'] ) ) {
foreach ( $field['value']['label'] as $key => $choice ) {
$image = ! empty( $field['value']['images'][ $key ] ) ? sprintf( '
', $field['value']['images'][ $key ] ) : '';
if ( ! empty( $choice ) ) {
$value[ $key ] = $image . $choice;
}
}
}
$export = array(
'label' => ! empty( $field['value']['name'] ) ? $field['value']['name'] : ucfirst( str_replace( '_', ' ', $field['type'] ) ) . " - {$field['id']}",
'value' => is_array( $value ) ? implode( '
', array_values( $value ) ) : false,
);
break;
default:
$export = array(
'label' => ! empty( $field['name'] ) ? $field['name'] : ucfirst( str_replace( '_', ' ', $field['type'] ) ) . " - {$field['id']}",
'value' => ! empty( $field['value'] ) ? is_array( $field['value'] ) ? $this->implode_recursive( $field['value'] ) : $field['value'] : false,
);
}
return $export;
}
/**
* Recursively process an array with an implosion.
*
* @since 1.6.6
*
* @param array $array Array that needs to be recursively imploded.
* @param string $delimiter Delimiter for the implosion - defaults to
.
*
* @return string $output Imploded array.
*/
protected function implode_recursive( $array, $delimiter = '
' ) {
$output = '';
foreach ( $array as $tuple ) {
if ( is_array( $tuple ) ) {
$output .= $this->implode_recursive( $tuple, ' ' );
} elseif ( ! empty( $tuple ) ) {
$output .= $delimiter . $tuple;
}
}
return $output;
}
}
', esc_url_raw( $image ) );
}
$field_content .= '