<?php

[0] Fix | Delete

[1] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[2] Fix | Delete

exit;

[3] Fix | Delete

}

[4] Fix | Delete

[5] Fix | Delete

use WPForms\Forms\Fields\Traits\NumberField as NumberFieldTrait;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Number Slider field.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.5.7

[11] Fix | Delete

*/

[12] Fix | Delete

class WPForms_Field_Number_Slider extends WPForms_Field {

[13] Fix | Delete

[14] Fix | Delete

use NumberFieldTrait;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Default minimum value of the field.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.5.7

[20] Fix | Delete

*/

[21] Fix | Delete

const SLIDER_MIN = 0;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Default maximum value of the field.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 1.5.7

[27] Fix | Delete

*/

[28] Fix | Delete

const SLIDER_MAX = 10;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Default step value of the field.

[32] Fix | Delete

*

[33] Fix | Delete

* @since 1.5.7

[34] Fix | Delete

*/

[35] Fix | Delete

const SLIDER_STEP = 1;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Primary class constructor.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 1.5.7

[41] Fix | Delete

*/

[42] Fix | Delete

public function init() {

[43] Fix | Delete

[44] Fix | Delete

// Define field type information.

[45] Fix | Delete

$this->name = esc_html__( 'Number Slider', 'wpforms-lite' );

[46] Fix | Delete

$this->type = 'number-slider';

[47] Fix | Delete

$this->icon = 'fa-sliders';

[48] Fix | Delete

$this->order = 180;

[49] Fix | Delete

[50] Fix | Delete

// Customize value format for HTML emails.

[51] Fix | Delete

add_filter( 'wpforms_html_field_value', [ $this, 'html_email_value' ], 10, 4 );

[52] Fix | Delete

[53] Fix | Delete

// Builder strings.

[54] Fix | Delete

add_filter( 'wpforms_builder_strings', [ $this, 'add_builder_strings' ] );

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Add Builder strings.

[59] Fix | Delete

*

[60] Fix | Delete

* @since 1.6.2.3

[61] Fix | Delete

*

[62] Fix | Delete

* @param array $strings Form Builder strings.

[63] Fix | Delete

*

[64] Fix | Delete

* @return array Form Builder strings.

[65] Fix | Delete

*/

[66] Fix | Delete

public function add_builder_strings( $strings ) {

[67] Fix | Delete

[68] Fix | Delete

$strings['error_number_slider_increment'] = esc_html__( 'Increment value should be greater than zero. Decimal fractions allowed.', 'wpforms-lite' );

[69] Fix | Delete

[70] Fix | Delete

return $strings;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Customize format for HTML email notifications.

[75] Fix | Delete

*

[76] Fix | Delete

* @since 1.5.7

[77] Fix | Delete

*

[78] Fix | Delete

* @param string $val Field value.

[79] Fix | Delete

* @param array $field Field settings.

[80] Fix | Delete

* @param array $form_data Form data and settings.

[81] Fix | Delete

* @param string $context Value display context.

[82] Fix | Delete

*

[83] Fix | Delete

* @return string

[84] Fix | Delete

*/

[85] Fix | Delete

public function html_email_value( $val, $field, $form_data = [], $context = '' ) {

[86] Fix | Delete

[87] Fix | Delete

if ( empty( $field['value_raw'] ) || $field['type'] !== $this->type ) {

[88] Fix | Delete

return $val;

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

$value = isset( $field['value_raw']['value'] ) ? (float) $field['value_raw']['value'] : 0;

[92] Fix | Delete

$min = isset( $field['value_raw']['min'] ) ? (float) $field['value_raw']['min'] : self::SLIDER_MIN;

[93] Fix | Delete

$max = isset( $field['value_raw']['max'] ) ? (float) $field['value_raw']['max'] : self::SLIDER_MAX;

[94] Fix | Delete

[95] Fix | Delete

$html_value = $value;

[96] Fix | Delete

if ( strpos( $field['value_raw']['value_display'], '{value}' ) !== false ) {

[97] Fix | Delete

$html_value = str_replace(

[98] Fix | Delete

'{value}',

[99] Fix | Delete

/* translators: %1$s - Number slider selected value, %2$s - its minimum value, %3$s - its maximum value. */

[100] Fix | Delete

sprintf( esc_html__( '%1$s (%2$s min / %3$s max)', 'wpforms-lite' ), $value, $min, $max ),

[101] Fix | Delete

$field['value_raw']['value_display']

[102] Fix | Delete

);

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

return $html_value;

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Field options panel inside the builder.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.5.7

[112] Fix | Delete

*

[113] Fix | Delete

* @param array $field Field settings.

[114] Fix | Delete

*/

[115] Fix | Delete

public function field_options( $field ) {

[116] Fix | Delete

/*

[117] Fix | Delete

* Basic field options.

[118] Fix | Delete

*/

[119] Fix | Delete

[120] Fix | Delete

// Set default values for Min, Max, Step, Default Value Options.

[121] Fix | Delete

$field = $this->set_default_field_args( $field );

[122] Fix | Delete

[123] Fix | Delete

// Options open markup.

[124] Fix | Delete

$args = [

[125] Fix | Delete

'markup' => 'open',

[126] Fix | Delete

];

[127] Fix | Delete

[128] Fix | Delete

$this->field_option( 'basic-options', $field, $args );

[129] Fix | Delete

[130] Fix | Delete

// Label.

[131] Fix | Delete

$this->field_option( 'label', $field );

[132] Fix | Delete

[133] Fix | Delete

// Description.

[134] Fix | Delete

$this->field_option( 'description', $field );

[135] Fix | Delete

[136] Fix | Delete

// Required toggle disabled.

[137] Fix | Delete

$this->field_element(

[138] Fix | Delete

'text',

[139] Fix | Delete

$field,

[140] Fix | Delete

[

[141] Fix | Delete

'slug' => 'required',

[142] Fix | Delete

'value' => '',

[143] Fix | Delete

'type' => 'hidden',

[144] Fix | Delete

]

[145] Fix | Delete

);

[146] Fix | Delete

[147] Fix | Delete

// Min/Max.

[148] Fix | Delete

$min_max_args = [

[149] Fix | Delete

'class' => 'wpforms-number-slider',

[150] Fix | Delete

'label' => esc_html__( 'Value Range', 'wpforms-lite' ),

[151] Fix | Delete

'tooltip' => esc_html__( 'Define the minimum and the maximum values for the slider.', 'wpforms-lite' ),

[152] Fix | Delete

];

[153] Fix | Delete

$min_max = $this->field_number_option_min_max( $field, $min_max_args, false );

[154] Fix | Delete

[155] Fix | Delete

// Default value.

[156] Fix | Delete

$default_value_args = [

[157] Fix | Delete

'class' => 'wpforms-number-slider-default-value',

[158] Fix | Delete

];

[159] Fix | Delete

$default_value = $this->field_number_option_default_value( $field, $default_value_args, false );

[160] Fix | Delete

[161] Fix | Delete

// Increment.

[162] Fix | Delete

$step_args = [

[163] Fix | Delete

'class' => 'wpforms-number-slider-step',

[164] Fix | Delete

'tooltip' => esc_html__( 'Determines the increment between selectable values on the slider.', 'wpforms-lite' ),

[165] Fix | Delete

];

[166] Fix | Delete

$step = $this->field_number_option_step( $field, $step_args, false );

[167] Fix | Delete

[168] Fix | Delete

// Print of options markup: Minimum, Maximum, Increment, Default Value.

[169] Fix | Delete

$this->field_element(

[170] Fix | Delete

'row',

[171] Fix | Delete

$field,

[172] Fix | Delete

[

[173] Fix | Delete

'slug' => 'number_min_max_step_dependent',

[174] Fix | Delete

'content' => $min_max . $default_value . $step,

[175] Fix | Delete

'class' => 'wpforms-field-number-slider-option',

[176] Fix | Delete

],

[177] Fix | Delete

true

[178] Fix | Delete

);

[179] Fix | Delete

[180] Fix | Delete

// Options close markup.

[181] Fix | Delete

$args = [

[182] Fix | Delete

'markup' => 'close',

[183] Fix | Delete

];

[184] Fix | Delete

[185] Fix | Delete

$this->field_option( 'basic-options', $field, $args );

[186] Fix | Delete

[187] Fix | Delete

/*

[188] Fix | Delete

* Advanced field options.

[189] Fix | Delete

*/

[190] Fix | Delete

[191] Fix | Delete

// Options open markup.

[192] Fix | Delete

$args = [

[193] Fix | Delete

'markup' => 'open',

[194] Fix | Delete

];

[195] Fix | Delete

[196] Fix | Delete

$this->field_option( 'advanced-options', $field, $args );

[197] Fix | Delete

[198] Fix | Delete

// Size.

[199] Fix | Delete

$this->field_option( 'size', $field );

[200] Fix | Delete

[201] Fix | Delete

// Value display.

[202] Fix | Delete

$lbl = $this->field_element(

[203] Fix | Delete

'label',

[204] Fix | Delete

$field,

[205] Fix | Delete

[

[206] Fix | Delete

'slug' => 'value_display',

[207] Fix | Delete

'value' => esc_html__( 'Value Display', 'wpforms-lite' ),

[208] Fix | Delete

'tooltip' => esc_html__( 'Displays the currently selected value below the slider.', 'wpforms-lite' ),

[209] Fix | Delete

],

[210] Fix | Delete

false

[211] Fix | Delete

);

[212] Fix | Delete

[213] Fix | Delete

$fld = $this->field_element(

[214] Fix | Delete

'text',

[215] Fix | Delete

$field,

[216] Fix | Delete

[

[217] Fix | Delete

'slug' => 'value_display',

[218] Fix | Delete

'class' => 'wpforms-number-slider-value-display',

[219] Fix | Delete

'value' => isset( $field['value_display'] ) ? $field['value_display'] : $this->get_default_display_value(),

[220] Fix | Delete

],

[221] Fix | Delete

false

[222] Fix | Delete

);

[223] Fix | Delete

[224] Fix | Delete

$this->field_element(

[225] Fix | Delete

'row',

[226] Fix | Delete

$field,

[227] Fix | Delete

[

[228] Fix | Delete

'slug' => 'value_display',

[229] Fix | Delete

'content' => $lbl . $fld,

[230] Fix | Delete

]

[231] Fix | Delete

);

[232] Fix | Delete

[233] Fix | Delete

// Custom CSS classes.

[234] Fix | Delete

$this->field_option( 'css', $field );

[235] Fix | Delete

[236] Fix | Delete

// Hide label.

[237] Fix | Delete

$this->field_option( 'label_hide', $field );

[238] Fix | Delete

[239] Fix | Delete

// Options close markup.

[240] Fix | Delete

$args = [

[241] Fix | Delete

'markup' => 'close',

[242] Fix | Delete

];

[243] Fix | Delete

[244] Fix | Delete

$this->field_option( 'advanced-options', $field, $args );

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

/**

[248] Fix | Delete

* Get default display value.

[249] Fix | Delete

*

[250] Fix | Delete

* @since 1.7.1

[251] Fix | Delete

*

[252] Fix | Delete

* @return string

[253] Fix | Delete

*/

[254] Fix | Delete

private function get_default_display_value() {

[255] Fix | Delete

[256] Fix | Delete

return sprintf( /* translators: %s - value. */

[257] Fix | Delete

esc_html__( 'Selected Value: %s', 'wpforms-lite' ),

[258] Fix | Delete

'{value}'

[259] Fix | Delete

);

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Field preview inside the builder.

[264] Fix | Delete

*

[265] Fix | Delete

* @since 1.5.7

[266] Fix | Delete

*

[267] Fix | Delete

* @param array $field Field data.

[268] Fix | Delete

*/

[269] Fix | Delete

public function field_preview( $field ) {

[270] Fix | Delete

[271] Fix | Delete

// Label.

[272] Fix | Delete

$this->field_preview_option( 'label', $field );

[273] Fix | Delete

[274] Fix | Delete

$value_display = isset( $field['value_display'] ) ? esc_attr( $field['value_display'] ) : $this->get_default_display_value();

[275] Fix | Delete

$default_value = ! empty( $field['default_value'] ) ? (float) $field['default_value'] : 0;

[276] Fix | Delete

[277] Fix | Delete

echo wpforms_render( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[278] Fix | Delete

'fields/number-slider/builder-preview',

[279] Fix | Delete

[

[280] Fix | Delete

'min' => isset( $field['min'] ) && is_numeric( $field['min'] ) ? (float) $field['min'] : self::SLIDER_MIN,

[281] Fix | Delete

'max' => isset( $field['max'] ) && is_numeric( $field['max'] ) ? (float) $field['max'] : self::SLIDER_MAX,

[282] Fix | Delete

'step' => isset( $field['step'] ) && is_numeric( $field['step'] ) ? (float) $field['step'] : self::SLIDER_STEP,

[283] Fix | Delete

'value_display' => $value_display,

[284] Fix | Delete

'default_value' => $default_value,

[285] Fix | Delete

'value_hint' => str_replace( '{value}', '<b>' . $default_value . '</b>', wp_kses( $value_display, wpforms_builder_preview_get_allowed_tags() ) ),

[286] Fix | Delete

'field_id' => $field['id'],

[287] Fix | Delete

],

[288] Fix | Delete

true

[289] Fix | Delete

);

[290] Fix | Delete

[291] Fix | Delete

// Description.

[292] Fix | Delete

$this->field_preview_option( 'description', $field );

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

/**

[296] Fix | Delete

* Field display on the form front-end.

[297] Fix | Delete

*

[298] Fix | Delete

* @since 1.5.7

[299] Fix | Delete

*

[300] Fix | Delete

* @param array $field Field data and settings.

[301] Fix | Delete

* @param array $deprecated Deprecated field attributes. Use $field['properties'] instead.

[302] Fix | Delete

* @param array $form_data Form data and settings.

[303] Fix | Delete

*/

[304] Fix | Delete

public function field_display( $field, $deprecated, $form_data ) {

[305] Fix | Delete

[306] Fix | Delete

// Define data.

[307] Fix | Delete

$primary = $field['properties']['inputs']['primary'];

[308] Fix | Delete

[309] Fix | Delete

$value_display = isset( $field['value_display'] ) ? esc_attr( $field['value_display'] ) : esc_html__( 'Selected Value: {value}', 'wpforms-lite' );

[310] Fix | Delete

$hint_value = ! empty( $primary['attr']['value'] ) ? (float) $primary['attr']['value'] : 0;

[311] Fix | Delete

[312] Fix | Delete

$hint = str_replace( '{value}', '<b>' . $hint_value . '</b>', $value_display );

[313] Fix | Delete

[314] Fix | Delete

// phpcs:ignore

[315] Fix | Delete

echo wpforms_render(

[316] Fix | Delete

'fields/number-slider/frontend',

[317] Fix | Delete

[

[318] Fix | Delete

'atts' => $primary['attr'],

[319] Fix | Delete

'class' => $primary['class'],

[320] Fix | Delete

'datas' => $primary['data'],

[321] Fix | Delete

'id' => $primary['id'],

[322] Fix | Delete

'max' => isset( $field['max'] ) && is_numeric( $field['max'] ) ? (float) $field['max'] : self::SLIDER_MAX,

[323] Fix | Delete

'min' => isset( $field['min'] ) && is_numeric( $field['min'] ) ? (float) $field['min'] : self::SLIDER_MIN,

[324] Fix | Delete

'required' => $primary['required'],

[325] Fix | Delete

'step' => isset( $field['step'] ) && is_numeric( $field['step'] ) ? (float) $field['step'] : self::SLIDER_STEP,

[326] Fix | Delete

'value_display' => $value_display,

[327] Fix | Delete

'value_hint' => $hint,

[328] Fix | Delete

],

[329] Fix | Delete

true

[330] Fix | Delete

);

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Validate field on form submit.

[335] Fix | Delete

*

[336] Fix | Delete

* @since 1.5.7

[337] Fix | Delete

*

[338] Fix | Delete

* @param int $field_id Field ID.

[339] Fix | Delete

* @param int|float|string $field_submit Submitted field value (raw data).

[340] Fix | Delete

* @param array $form_data Form data and settings.

[341] Fix | Delete

*/

[342] Fix | Delete

public function validate( $field_id, $field_submit, $form_data ) {

[343] Fix | Delete

[344] Fix | Delete

$form_id = $form_data['id'];

[345] Fix | Delete

[346] Fix | Delete

$field_submit = (float) $this->sanitize_value( $field_submit );

[347] Fix | Delete

[348] Fix | Delete

// Basic required check - if field is marked as required, check for entry data.

[349] Fix | Delete

if (

[350] Fix | Delete

! empty( $form_data['fields'][ $field_id ]['required'] ) &&

[351] Fix | Delete

empty( $field_submit ) &&

[352] Fix | Delete

(string) $field_submit !== '0'

[353] Fix | Delete

) {

[354] Fix | Delete

wpforms()->obj( 'process' )->errors[ $form_id ][ $field_id ] = wpforms_get_required_label();

[355] Fix | Delete

}

[356] Fix | Delete

[357] Fix | Delete

// Check if value is numeric.

[358] Fix | Delete

if ( ! empty( $field_submit ) && ! is_numeric( $field_submit ) ) {

[359] Fix | Delete

/**

[360] Fix | Delete

* Filter the error message for the number field.

[361] Fix | Delete

*

[362] Fix | Delete

* @since 1.0.0

[363] Fix | Delete

*

[364] Fix | Delete

* @param string $message Error message.

[365] Fix | Delete

*/

[366] Fix | Delete

wpforms()->obj( 'process' )->errors[ $form_id ][ $field_id ] = apply_filters( 'wpforms_valid_number_label', esc_html__( 'Please provide a valid value.', 'wpforms-lite' ) ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[367] Fix | Delete

}

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

/**

[371] Fix | Delete

* Format and sanitize field.

[372] Fix | Delete

*

[373] Fix | Delete

* @since 1.5.7

[374] Fix | Delete

*

[375] Fix | Delete

* @param int $field_id Field ID.

[376] Fix | Delete

* @param int|string|float $field_submit Submitted field value.

[377] Fix | Delete

* @param array $form_data Form data and settings.

[378] Fix | Delete

*/

[379] Fix | Delete

public function format( $field_id, $field_submit, $form_data ) {

[380] Fix | Delete

[381] Fix | Delete

// Define data.

[382] Fix | Delete

$name = ! empty( $form_data['fields'][ $field_id ]['label'] ) ? $form_data['fields'][ $field_id ]['label'] : '';

[383] Fix | Delete

$value = (float) $this->sanitize_value( $field_submit );

[384] Fix | Delete

[385] Fix | Delete

$value_raw = [

[386] Fix | Delete

'value' => $value,

[387] Fix | Delete

'min' => (float) $form_data['fields'][ $field_id ]['min'],

[388] Fix | Delete

'max' => (float) $form_data['fields'][ $field_id ]['max'],

[389] Fix | Delete

'value_display' => wp_kses_post( $form_data['fields'][ $field_id ]['value_display'] ),

[390] Fix | Delete

];

[391] Fix | Delete

[392] Fix | Delete

// Set final field details.

[393] Fix | Delete

wpforms()->obj( 'process' )->fields[ $field_id ] = [

[394] Fix | Delete

'name' => sanitize_text_field( $name ),

[395] Fix | Delete

'value' => $value,

[396] Fix | Delete

'value_raw' => $value_raw,

[397] Fix | Delete

'id' => wpforms_validate_field_id( $field_id ),

[398] Fix | Delete

'type' => $this->type,

[399] Fix | Delete

];

[400] Fix | Delete

}

[401] Fix | Delete

[402] Fix | Delete

/**

[403] Fix | Delete

* Sanitize the value.

[404] Fix | Delete

*

[405] Fix | Delete

* @since 1.5.7

[406] Fix | Delete

*

[407] Fix | Delete

* @param string $value The number field submitted value.

[408] Fix | Delete

*

[409] Fix | Delete

* @return float|int|string

[410] Fix | Delete

*/

[411] Fix | Delete

private function sanitize_value( $value ) {

[412] Fix | Delete

[413] Fix | Delete

// Some browsers allow other non-digit/decimal characters to be submitted

[414] Fix | Delete

// with the num input, which then trips the is_numeric validation below.

[415] Fix | Delete

// To get around this we remove all chars that are not expected.

[416] Fix | Delete

$signed_value = preg_replace( '/[^-0-9.]/', '', $value );

[417] Fix | Delete

[418] Fix | Delete

// If there's no number on the signed value we return zero.

[419] Fix | Delete

// We have to do that because since PHP 8.0, the abs() function is allowed an argument with int|float type.

[420] Fix | Delete

if ( ! is_numeric( $signed_value ) ) {

[421] Fix | Delete

return 0;

[422] Fix | Delete

}

[423] Fix | Delete

[424] Fix | Delete

$abs_value = abs( $signed_value );

[425] Fix | Delete

$value = strpos( $signed_value, '-' ) === 0 ? '-' . $abs_value : $abs_value;

[426] Fix | Delete

[427] Fix | Delete

return $value;

[428] Fix | Delete

}

[429] Fix | Delete

[430] Fix | Delete

/**

[431] Fix | Delete

* Sets default field settings.

[432] Fix | Delete

*

[433] Fix | Delete

* @since 1.9.4

[434] Fix | Delete

*

[435] Fix | Delete

* @param array $field Field settings.

[436] Fix | Delete

*

[437] Fix | Delete

* @return array Modified array.

[438] Fix | Delete

*/

[439] Fix | Delete

private function set_default_field_args( $field ) {

[440] Fix | Delete

[441] Fix | Delete

$field['min'] = empty( $field['min'] ) ? self::SLIDER_MIN : $field['min'];

[442] Fix | Delete

$field['max'] = empty( $field['max'] ) ? self::SLIDER_MAX : $field['max'];

[443] Fix | Delete

$field['step'] = empty( $field['step'] ) ? self::SLIDER_STEP : $field['step'];

[444] Fix | Delete

$field['default_value'] = empty( $field['default_value'] ) ? self::SLIDER_MIN : $field['default_value'];

[445] Fix | Delete

[446] Fix | Delete

return $field;

[447] Fix | Delete

}

[448] Fix | Delete

}

[449] Fix | Delete

[450] Fix | Delete

new WPForms_Field_Number_Slider();

[451] Fix | Delete

[452] Fix | Delete