<?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 text field.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.0.0

[11] Fix | Delete

*/

[12] Fix | Delete

class WPForms_Field_Number extends WPForms_Field {

[13] Fix | Delete

[14] Fix | Delete

use NumberFieldTrait;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Primary class constructor.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.0.0

[20] Fix | Delete

*/

[21] Fix | Delete

public function init() {

[22] Fix | Delete

[23] Fix | Delete

// Define field type information.

[24] Fix | Delete

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

[25] Fix | Delete

$this->type = 'number';

[26] Fix | Delete

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

[27] Fix | Delete

$this->order = 130;

[28] Fix | Delete

[29] Fix | Delete

$this->hooks();

[30] Fix | Delete

$this->number_hooks();

[31] Fix | Delete

}

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Hooks.

[35] Fix | Delete

*

[36] Fix | Delete

* @since 1.9.4

[37] Fix | Delete

*/

[38] Fix | Delete

private function hooks() {

[39] Fix | Delete

[40] Fix | Delete

// Define additional field properties.

[41] Fix | Delete

add_filter( 'wpforms_field_properties_number', [ $this, 'field_properties' ], 5, 3 );

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Define additional field properties.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 1.9.4

[48] Fix | Delete

*

[49] Fix | Delete

* @param array|mixed $properties Field properties.

[50] Fix | Delete

* @param array $field Field settings.

[51] Fix | Delete

* @param array $form_data Form data and settings.

[52] Fix | Delete

*

[53] Fix | Delete

* @return array

[54] Fix | Delete

* @noinspection PhpMissingParamTypeInspection

[55] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[56] Fix | Delete

*/

[57] Fix | Delete

public function field_properties( $properties, $field, $form_data ): array {

[58] Fix | Delete

[59] Fix | Delete

$properties = (array) $properties;

[60] Fix | Delete

[61] Fix | Delete

if ( is_numeric( $field['min'] ?? null ) ) {

[62] Fix | Delete

$properties['inputs']['primary']['attr']['min'] = (float) $field['min'];

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

if ( is_numeric( $field['max'] ?? null ) ) {

[66] Fix | Delete

$properties['inputs']['primary']['attr']['max'] = (float) $field['max'];

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

$properties['inputs']['primary']['attr']['step'] = 'any';

[70] Fix | Delete

[71] Fix | Delete

return $properties;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Field options panel inside the builder.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 1.0.0

[78] Fix | Delete

*

[79] Fix | Delete

* @param array $field Field data.

[80] Fix | Delete

*/

[81] Fix | Delete

public function field_options( $field ) {

[82] Fix | Delete

/*

[83] Fix | Delete

* Basic field options.

[84] Fix | Delete

*/

[85] Fix | Delete

[86] Fix | Delete

// Options open markup.

[87] Fix | Delete

$args = [

[88] Fix | Delete

'markup' => 'open',

[89] Fix | Delete

];

[90] Fix | Delete

[91] Fix | Delete

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

[92] Fix | Delete

[93] Fix | Delete

// Label.

[94] Fix | Delete

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

[95] Fix | Delete

[96] Fix | Delete

// Description.

[97] Fix | Delete

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

[98] Fix | Delete

[99] Fix | Delete

// Required toggle.

[100] Fix | Delete

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

[101] Fix | Delete

[102] Fix | Delete

// Options close markup.

[103] Fix | Delete

$args = [

[104] Fix | Delete

'markup' => 'close',

[105] Fix | Delete

];

[106] Fix | Delete

[107] Fix | Delete

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

[108] Fix | Delete

[109] Fix | Delete

/*

[110] Fix | Delete

* Advanced field options.

[111] Fix | Delete

*/

[112] Fix | Delete

[113] Fix | Delete

// Options open markup.

[114] Fix | Delete

$args = [

[115] Fix | Delete

'markup' => 'open',

[116] Fix | Delete

];

[117] Fix | Delete

[118] Fix | Delete

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

[119] Fix | Delete

[120] Fix | Delete

// Size.

[121] Fix | Delete

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

[122] Fix | Delete

[123] Fix | Delete

// Placeholder.

[124] Fix | Delete

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

[125] Fix | Delete

[126] Fix | Delete

// Min/Max.

[127] Fix | Delete

$this->field_number_option_min_max( $field, [ 'class' => 'wpforms-numbers' ] );

[128] Fix | Delete

[129] Fix | Delete

// Default value.

[130] Fix | Delete

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

[131] Fix | Delete

[132] Fix | Delete

// Custom CSS classes.

[133] Fix | Delete

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

[134] Fix | Delete

[135] Fix | Delete

// Hide label.

[136] Fix | Delete

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

[137] Fix | Delete

[138] Fix | Delete

// Options close markup.

[139] Fix | Delete

$args = [

[140] Fix | Delete

'markup' => 'close',

[141] Fix | Delete

];

[142] Fix | Delete

[143] Fix | Delete

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

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Field preview inside the builder.

[148] Fix | Delete

*

[149] Fix | Delete

* @since 1.0.0

[150] Fix | Delete

*

[151] Fix | Delete

* @param array $field Field data.

[152] Fix | Delete

*/

[153] Fix | Delete

public function field_preview( $field ) {

[154] Fix | Delete

[155] Fix | Delete

// Define data.

[156] Fix | Delete

$placeholder = ! empty( $field['placeholder'] ) ? $field['placeholder'] : '';

[157] Fix | Delete

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

[158] Fix | Delete

[159] Fix | Delete

// Label.

[160] Fix | Delete

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

[161] Fix | Delete

[162] Fix | Delete

// Primary input.

[163] Fix | Delete

echo '<input type="text" placeholder="' . esc_attr( $placeholder ) . '" value="' . esc_attr( $default_value ) . '" class="primary-input" readonly>';

[164] Fix | Delete

[165] Fix | Delete

// Description.

[166] Fix | Delete

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

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Field display on the form front-end.

[171] Fix | Delete

*

[172] Fix | Delete

* @since 1.0.0

[173] Fix | Delete

*

[174] Fix | Delete

* @param array $field Field data.

[175] Fix | Delete

* @param array $deprecated Deprecated, not used.

[176] Fix | Delete

* @param array $form_data Form data.

[177] Fix | Delete

*/

[178] Fix | Delete

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

[179] Fix | Delete

[180] Fix | Delete

// Define data.

[181] Fix | Delete

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

[182] Fix | Delete

[183] Fix | Delete

// Primary field.

[184] Fix | Delete

printf(

[185] Fix | Delete

'<input type="number" %s %s>',

[186] Fix | Delete

wpforms_html_attributes( $primary['id'], $primary['class'], $primary['data'], $primary['attr'] ),

[187] Fix | Delete

esc_attr( $primary['required'] )

[188] Fix | Delete

);

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Validate field on form submit.

[193] Fix | Delete

*

[194] Fix | Delete

* @since 1.0.0

[195] Fix | Delete

*

[196] Fix | Delete

* @param int $field_id Field id.

[197] Fix | Delete

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

[198] Fix | Delete

* @param array $form_data Form data.

[199] Fix | Delete

*/

[200] Fix | Delete

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

[201] Fix | Delete

[202] Fix | Delete

$form_id = $form_data['id'];

[203] Fix | Delete

[204] Fix | Delete

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

[205] Fix | Delete

[206] Fix | Delete

// If field is marked as required, check for entry data.

[207] Fix | Delete

if (

[208] Fix | Delete

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

[209] Fix | Delete

empty( $value ) &&

[210] Fix | Delete

! is_numeric( $value )

[211] Fix | Delete

) {

[212] Fix | Delete

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

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

// Check if value is numeric.

[216] Fix | Delete

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

[217] Fix | Delete

/**

[218] Fix | Delete

* Filter the error message for the number field.

[219] Fix | Delete

*

[220] Fix | Delete

* @since 1.0.0

[221] Fix | Delete

*

[222] Fix | Delete

* @param string $message Error message.

[223] Fix | Delete

*/

[224] Fix | Delete

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

[225] Fix | Delete

}

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Format and sanitize field.

[230] Fix | Delete

*

[231] Fix | Delete

* @since 1.3.5

[232] Fix | Delete

*

[233] Fix | Delete

* @param int $field_id Field id.

[234] Fix | Delete

* @param string $field_submit Submitted value.

[235] Fix | Delete

* @param array $form_data Form data.

[236] Fix | Delete

*/

[237] Fix | Delete

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

[238] Fix | Delete

[239] Fix | Delete

// Define data.

[240] Fix | Delete

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

[241] Fix | Delete

[242] Fix | Delete

// Set final field details.

[243] Fix | Delete

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

[244] Fix | Delete

'name' => sanitize_text_field( $name ),

[245] Fix | Delete

'value' => $this->sanitize_value( $field_submit ),

[246] Fix | Delete

'id' => wpforms_validate_field_id( $field_id ),

[247] Fix | Delete

'type' => $this->type,

[248] Fix | Delete

];

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

/**

[252] Fix | Delete

* Sanitize the value.

[253] Fix | Delete

*

[254] Fix | Delete

* @since 1.5.7

[255] Fix | Delete

*

[256] Fix | Delete

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

[257] Fix | Delete

*

[258] Fix | Delete

* @return float|int|string

[259] Fix | Delete

*/

[260] Fix | Delete

private function sanitize_value( $value ) {

[261] Fix | Delete

[262] Fix | Delete

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

[263] Fix | Delete

return '';

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

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

[267] Fix | Delete

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

[268] Fix | Delete

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

[269] Fix | Delete

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

[270] Fix | Delete

$abs_value = str_replace( '-', '', $signed_value );

[271] Fix | Delete

[272] Fix | Delete

return $signed_value < 0 ? '-' . $abs_value : $abs_value;

[273] Fix | Delete

}

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

new WPForms_Field_Number();

[277] Fix | Delete

[278] Fix | Delete