<?php

[0] Fix | Delete

[1] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[2] Fix | Delete

exit;

[3] Fix | Delete

}

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* GDPR Checkbox field.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.4.6

[9] Fix | Delete

*/

[10] Fix | Delete

class WPForms_Field_GDPR_Checkbox extends WPForms_Field {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Primary class constructor.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.4.6

[16] Fix | Delete

*/

[17] Fix | Delete

public function init() {

[18] Fix | Delete

[19] Fix | Delete

// Define field type information.

[20] Fix | Delete

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

[21] Fix | Delete

$this->type = 'gdpr-checkbox';

[22] Fix | Delete

$this->icon = 'fa-check-square-o';

[23] Fix | Delete

$this->order = 500;

[24] Fix | Delete

$this->allow_read_only = false;

[25] Fix | Delete

$this->defaults = [

[26] Fix | Delete

1 => [

[27] Fix | Delete

'label' => esc_html__( 'I consent to having this website store my submitted information so they can respond to my inquiry.', 'wpforms-lite' ),

[28] Fix | Delete

'value' => '',

[29] Fix | Delete

'image' => '',

[30] Fix | Delete

'default' => '',

[31] Fix | Delete

],

[32] Fix | Delete

];

[33] Fix | Delete

[34] Fix | Delete

$this->default_settings = [

[35] Fix | Delete

'choices' => $this->defaults,

[36] Fix | Delete

];

[37] Fix | Delete

[38] Fix | Delete

// Set field to default to the required.

[39] Fix | Delete

add_filter( 'wpforms_field_new_required', [ $this, 'field_default_required' ], 10, 2 );

[40] Fix | Delete

[41] Fix | Delete

// Define additional field properties.

[42] Fix | Delete

add_filter( 'wpforms_field_properties_gdpr-checkbox', [ $this, 'field_properties' ], 5, 3 );

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Field should default to being required.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.4.6

[49] Fix | Delete

*

[50] Fix | Delete

* @param bool $required Required status, true is required.

[51] Fix | Delete

* @param array $field Field settings.

[52] Fix | Delete

*

[53] Fix | Delete

* @return bool

[54] Fix | Delete

*/

[55] Fix | Delete

public function field_default_required( $required, $field ) {

[56] Fix | Delete

[57] Fix | Delete

if ( $this->type === $field['type'] ) {

[58] Fix | Delete

return true;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

return $required;

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Define additional field properties.

[66] Fix | Delete

*

[67] Fix | Delete

* @since 1.4.6

[68] Fix | Delete

*

[69] Fix | Delete

* @param array $properties Field properties.

[70] Fix | Delete

* @param array $field Field settings.

[71] Fix | Delete

* @param array $form_data Form data and settings.

[72] Fix | Delete

*

[73] Fix | Delete

* @return array

[74] Fix | Delete

*/

[75] Fix | Delete

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

[76] Fix | Delete

[77] Fix | Delete

// Define data.

[78] Fix | Delete

$form_id = absint( $form_data['id'] );

[79] Fix | Delete

$field_id = absint( $field['id'] );

[80] Fix | Delete

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

[81] Fix | Delete

[82] Fix | Delete

// Remove primary input, unset for attribute for label.

[83] Fix | Delete

unset( $properties['inputs']['primary'], $properties['label']['attr']['for'] );

[84] Fix | Delete

[85] Fix | Delete

// Set input container (ul) properties.

[86] Fix | Delete

$properties['input_container'] = [

[87] Fix | Delete

'class' => [],

[88] Fix | Delete

'data' => [],

[89] Fix | Delete

'attr' => [],

[90] Fix | Delete

'id' => "wpforms-{$form_id}-field_{$field_id}",

[91] Fix | Delete

];

[92] Fix | Delete

[93] Fix | Delete

// Set input properties.

[94] Fix | Delete

foreach ( $choices as $key => $choice ) {

[95] Fix | Delete

[96] Fix | Delete

$properties['inputs'][ $key ] = [

[97] Fix | Delete

'container' => [

[98] Fix | Delete

'attr' => [],

[99] Fix | Delete

'class' => [ "choice-{$key}" ],

[100] Fix | Delete

'data' => [],

[101] Fix | Delete

'id' => '',

[102] Fix | Delete

],

[103] Fix | Delete

'label' => [

[104] Fix | Delete

'attr' => [

[105] Fix | Delete

'for' => "wpforms-{$form_id}-field_{$field_id}_{$key}",

[106] Fix | Delete

],

[107] Fix | Delete

'class' => [ 'wpforms-field-label-inline' ],

[108] Fix | Delete

'data' => [],

[109] Fix | Delete

'id' => '',

[110] Fix | Delete

'text' => $choice['label'],

[111] Fix | Delete

],

[112] Fix | Delete

'attr' => [

[113] Fix | Delete

'name' => "wpforms[fields][{$field_id}][]",

[114] Fix | Delete

'value' => $choice['label'],

[115] Fix | Delete

],

[116] Fix | Delete

'class' => [],

[117] Fix | Delete

'data' => [],

[118] Fix | Delete

'id' => "wpforms-{$form_id}-field_{$field_id}_{$key}",

[119] Fix | Delete

'image' => '',

[120] Fix | Delete

'required' => ! empty( $field['required'] ) ? 'required' : '',

[121] Fix | Delete

'default' => '',

[122] Fix | Delete

];

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

// Required class for pagebreak validation.

[126] Fix | Delete

if ( ! empty( $field['required'] ) ) {

[127] Fix | Delete

$properties['input_container']['class'][] = 'wpforms-field-required';

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

return $properties;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Whether the current field can be populated dynamically.

[135] Fix | Delete

*

[136] Fix | Delete

* @since 1.9.4

[137] Fix | Delete

*

[138] Fix | Delete

* @param array $properties Field properties.

[139] Fix | Delete

* @param array $field Current field specific data.

[140] Fix | Delete

*

[141] Fix | Delete

* @return bool

[142] Fix | Delete

*/

[143] Fix | Delete

public function is_dynamic_population_allowed( $properties, $field ): bool {

[144] Fix | Delete

[145] Fix | Delete

return false;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Field options panel inside the builder.

[150] Fix | Delete

*

[151] Fix | Delete

* @since 1.4.6

[152] Fix | Delete

*

[153] Fix | Delete

* @param array $field Field settings.

[154] Fix | Delete

*/

[155] Fix | Delete

public function field_options( $field ) {

[156] Fix | Delete

[157] Fix | Delete

// Field is always required.

[158] Fix | Delete

$this->field_element(

[159] Fix | Delete

'text',

[160] Fix | Delete

$field,

[161] Fix | Delete

[

[162] Fix | Delete

'type' => 'hidden',

[163] Fix | Delete

'slug' => 'required',

[164] Fix | Delete

'value' => '1',

[165] Fix | Delete

]

[166] Fix | Delete

);

[167] Fix | Delete

[168] Fix | Delete

// -------------------------------------------------------------------//

[169] Fix | Delete

// Basic field options

[170] Fix | Delete

// -------------------------------------------------------------------//

[171] Fix | Delete

[172] Fix | Delete

// Options open markup.

[173] Fix | Delete

$this->field_option(

[174] Fix | Delete

'basic-options',

[175] Fix | Delete

$field,

[176] Fix | Delete

[

[177] Fix | Delete

'markup' => 'open',

[178] Fix | Delete

]

[179] Fix | Delete

);

[180] Fix | Delete

[181] Fix | Delete

// Label.

[182] Fix | Delete

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

[183] Fix | Delete

[184] Fix | Delete

// Choices.

[185] Fix | Delete

$this->field_option(

[186] Fix | Delete

'choices',

[187] Fix | Delete

$field,

[188] Fix | Delete

[

[189] Fix | Delete

'label' => esc_html__( 'Agreement', 'wpforms-lite' ),

[190] Fix | Delete

]

[191] Fix | Delete

);

[192] Fix | Delete

[193] Fix | Delete

// Description.

[194] Fix | Delete

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

[195] Fix | Delete

[196] Fix | Delete

// Options close markup.

[197] Fix | Delete

$this->field_option(

[198] Fix | Delete

'basic-options',

[199] Fix | Delete

$field,

[200] Fix | Delete

[

[201] Fix | Delete

'markup' => 'close',

[202] Fix | Delete

]

[203] Fix | Delete

);

[204] Fix | Delete

[205] Fix | Delete

// -------------------------------------------------------------------//

[206] Fix | Delete

// Advanced field options

[207] Fix | Delete

// -------------------------------------------------------------------//

[208] Fix | Delete

[209] Fix | Delete

// Options open markup.

[210] Fix | Delete

$this->field_option(

[211] Fix | Delete

'advanced-options',

[212] Fix | Delete

$field,

[213] Fix | Delete

[

[214] Fix | Delete

'markup' => 'open',

[215] Fix | Delete

]

[216] Fix | Delete

);

[217] Fix | Delete

[218] Fix | Delete

// Custom CSS classes.

[219] Fix | Delete

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

[220] Fix | Delete

[221] Fix | Delete

// Hide label.

[222] Fix | Delete

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

[223] Fix | Delete

[224] Fix | Delete

// Options close markup.

[225] Fix | Delete

$this->field_option(

[226] Fix | Delete

'advanced-options',

[227] Fix | Delete

$field,

[228] Fix | Delete

[

[229] Fix | Delete

'markup' => 'close',

[230] Fix | Delete

]

[231] Fix | Delete

);

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

/**

[235] Fix | Delete

* Field preview inside the builder.

[236] Fix | Delete

*

[237] Fix | Delete

* @since 1.4.6

[238] Fix | Delete

*

[239] Fix | Delete

* @param array $field Field settings.

[240] Fix | Delete

*/

[241] Fix | Delete

public function field_preview( $field ) {

[242] Fix | Delete

[243] Fix | Delete

// Label.

[244] Fix | Delete

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

[245] Fix | Delete

[246] Fix | Delete

// Choices.

[247] Fix | Delete

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

[248] Fix | Delete

[249] Fix | Delete

// Description.

[250] Fix | Delete

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

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

/**

[254] Fix | Delete

* Field display on the form front-end.

[255] Fix | Delete

*

[256] Fix | Delete

* @since 1.4.6

[257] Fix | Delete

*

[258] Fix | Delete

* @param array $field Field settings.

[259] Fix | Delete

* @param array $deprecated Deprecated array.

[260] Fix | Delete

* @param array $form_data Form data and settings.

[261] Fix | Delete

*

[262] Fix | Delete

* @noinspection HtmlUnknownAttribute

[263] Fix | Delete

*/

[264] Fix | Delete

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

[265] Fix | Delete

[266] Fix | Delete

// Define data.

[267] Fix | Delete

$container = $field['properties']['input_container'];

[268] Fix | Delete

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

[269] Fix | Delete

[270] Fix | Delete

printf(

[271] Fix | Delete

'<ul %s>',

[272] Fix | Delete

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

[273] Fix | Delete

);

[274] Fix | Delete

[275] Fix | Delete

foreach ( $choices as $choice ) {

[276] Fix | Delete

$required = '';

[277] Fix | Delete

[278] Fix | Delete

if ( ! empty( $choice['required'] ) && ! empty( $field['label_hide'] ) ) {

[279] Fix | Delete

$required = wpforms_get_field_required_label();

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

printf(

[283] Fix | Delete

'<li %s>',

[284] Fix | Delete

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

[285] Fix | Delete

);

[286] Fix | Delete

// Normal display.

[287] Fix | Delete

printf(

[288] Fix | Delete

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

[289] Fix | Delete

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

[290] Fix | Delete

esc_attr( $choice['required'] ),

[291] Fix | Delete

checked( '1', $choice['default'], false )

[292] Fix | Delete

);

[293] Fix | Delete

[294] Fix | Delete

printf(

[295] Fix | Delete

'<label %s>%s%s</label>',

[296] Fix | Delete

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

[297] Fix | Delete

wp_kses_post( $choice['label']['text'] ),

[298] Fix | Delete

wp_kses_post( $required )

[299] Fix | Delete

);

[300] Fix | Delete

[301] Fix | Delete

echo '</li>';

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

echo '</ul>';

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

/**

[308] Fix | Delete

* Format and sanitize field.

[309] Fix | Delete

*

[310] Fix | Delete

* @since 1.4.6

[311] Fix | Delete

*

[312] Fix | Delete

* @param int $field_id Field ID.

[313] Fix | Delete

* @param array $field_submit Submitted form data.

[314] Fix | Delete

* @param array $form_data Form data and settings.

[315] Fix | Delete

*/

[316] Fix | Delete

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

[317] Fix | Delete

[318] Fix | Delete

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

[319] Fix | Delete

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

[320] Fix | Delete

'value' => $form_data['fields'][ $field_id ]['choices'][1]['label'],

[321] Fix | Delete

'id' => wpforms_validate_field_id( $field_id ),

[322] Fix | Delete

'type' => $this->type,

[323] Fix | Delete

];

[324] Fix | Delete

}

[325] Fix | Delete

}

[326] Fix | Delete

[327] Fix | Delete

new WPForms_Field_GDPR_Checkbox();

[328] Fix | Delete

[329] Fix | Delete