his->field_option( 'choices_icons', $field );
// Choices Icons Color.
$this->field_option( 'choices_icons_color', $field );
// Choices Icons Size.
$this->field_option( 'choices_icons_size', $field );
// Choices Icons Style.
$this->field_option( 'choices_icons_style', $field );
// Description.
$this->field_option( 'description', $field );
// Required toggle.
$this->field_option( 'required', $field );
// Options close markup.
$this->field_option(
'basic-options',
$field,
[
'markup' => 'close',
]
);
/*
* Advanced field options.
*/
// Options open markup.
$this->field_option(
'advanced-options',
$field,
[
'markup' => 'open',
]
);
// Input columns.
$this->field_option( 'input_columns', $field );
// Custom CSS classes.
$this->field_option( 'css', $field );
// Hide label.
$this->field_option( 'label_hide', $field );
// Options close markup.
$this->field_option(
'advanced-options',
$field,
[
'markup' => 'close',
]
);
}
/**
* Field preview inside the builder.
*
* @since 1.8.2
*
* @param array $field Field settings.
*/
public function field_preview( $field ) {
// Label.
$this->field_preview_option( 'label', $field );
// Choices.
$this->field_preview_option( 'choices', $field );
// Description.
$this->field_preview_option( 'description', $field );
}
/**
* Field display on the form front-end.
*
* @since 1.8.2
*
* @param array $field Field settings.
* @param array $deprecated Deprecated array.
* @param array $form_data Form data and settings.
*/
public function field_display( $field, $deprecated, $form_data ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh
// Define data.
$container = $field['properties']['input_container'];
$choices = $field['properties']['inputs'];
printf(
'
',
wpforms_html_attributes( $container['id'], $container['class'], $container['data'], $container['attr'] ) // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
);
foreach ( $choices as $key => $choice ) {
$label = isset( $choice['label']['text'] ) ? $choice['label']['text'] : '';
/* translators: %s - item number. */
$label = $label !== '' ? $label : sprintf( esc_html__( 'Item %s', 'wpforms-lite' ), $key );
$label .= ! empty( $field['show_price_after_labels'] ) && isset( $choice['data']['amount'] ) ? ' - ' . wpforms_format_amount( wpforms_sanitize_amount( $choice['data']['amount'] ), true ) : '';
printf(
'- ',
wpforms_html_attributes( $choice['container']['id'], $choice['container']['class'], $choice['container']['data'], $choice['container']['attr'] ) // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
);
if ( empty( $field['dynamic_choices'] ) && ! empty( $field['choices_images'] ) ) {
// Image choices.
printf(
'';
} elseif ( empty( $field['dynamic_choices'] ) && ! empty( $field['choices_icons'] ) ) {
// Icon Choices.
wpforms()->obj( 'icon_choices' )->field_display( $field, $choice, 'checkbox', $label );
} else {
// Normal display.
printf(
'',
wpforms_html_attributes( $choice['id'], $choice['class'], $choice['data'], $choice['attr'] ), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
esc_attr( $choice['required'] ),
checked( '1', $choice['default'], false )
);
printf(
'',
wpforms_html_attributes( $choice['label']['id'], $choice['label']['class'], $choice['label']['data'], $choice['label']['attr'] ), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
wp_kses_post( $label )
);
}
echo '
';
}
echo '
';
}
/**
* Validate field on form submit.
*
* @since 1.8.2
*
* @param int $field_id Field ID.
* @param array $field_submit Submitted field value (raw data).
* @param array $form_data Form data and settings.
*/
public function validate( $field_id, $field_submit, $form_data ) {
$error = '';
// Basic required check - If field is marked as required, check for entry data.
if ( ! empty( $form_data['fields'][ $field_id ]['required'] ) && empty( $field_submit ) ) {
$error = wpforms_get_required_label();
}
if ( ! empty( $field_submit ) ) {
foreach ( (array) $field_submit as $checked_choice ) {
// Validate that the option selected is real.
if ( empty( $form_data['fields'][ $field_id ]['choices'][ (int) $checked_choice ] ) ) {
$error = esc_html__( 'Invalid payment option.', 'wpforms-lite' );
break;
}
}
}
if ( ! empty( $error ) ) {
wpforms()->obj( 'process' )->errors[ $form_data['id'] ][ $field_id ] = $error;
}
}
/**
* Format and sanitize field.
*
* @since 1.8.2
*
* @param int $field_id Field ID.
* @param array $field_submit Array of selected choice IDs.
* @param array $form_data Form data and settings.
*/
public function format( $field_id, $field_submit, $form_data ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh, Generic.Metrics.NestingLevel.MaxExceeded
$field_submit = array_values( (array) $field_submit );
$field = $form_data['fields'][ $field_id ];
$name = sanitize_text_field( $field['label'] );
$amount = 0;
$images = [];
$choice_values = [];
$choice_labels = [];
$choice_keys = [];
if ( ! empty( $field_submit ) ) {
foreach ( $field_submit as $choice_checked ) {
foreach ( $field['choices'] as $choice_id => $choice ) {
// Exit early.
if ( (int) $choice_checked !== (int) $choice_id ) {
continue;
}
$value = (float) wpforms_sanitize_amount( $choice['value'] );
// Increase total amount.
$amount += $value;
$value = wpforms_format_amount( $value, true );
$choice_label = '';
if ( ! empty( $choice['label'] ) ) {
$choice_label = sanitize_text_field( $choice['label'] );
$value = $choice_label . ' - ' . $value;
}
$choice_labels[] = $choice_label;
$choice_values[] = $value;
$choice_keys[] = $choice_id;
}
}
if ( ! empty( $choice_keys ) && ! empty( $field['choices_images'] ) ) {
foreach ( $choice_keys as $choice_key ) {
$images[] = ! empty( $field['choices'][ $choice_key ]['image'] ) ? esc_url_raw( $field['choices'][ $choice_key ]['image'] ) : '';
}
}
}
wpforms()->obj( 'process' )->fields[ $field_id ] = [
'name' => $name,
'value' => implode( "\r\n", $choice_values ),
'value_choice' => implode( "\r\n", $choice_labels ),
'value_raw' => implode( ',', array_map( 'absint', $field_submit ) ),
'amount' => wpforms_format_amount( $amount ),
'amount_raw' => $amount,
'currency' => wpforms_get_currency(),
'images' => $images,
'id' => absint( $field_id ),
'type' => sanitize_key( $this->type ),
];
}
}