<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Helper functions to work with forms and form data.

[2] Fix | Delete

*

[3] Fix | Delete

* @since 1.8.0

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Helper function to trigger displaying a form.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.0.2

[10] Fix | Delete

*

[11] Fix | Delete

* @param mixed $form_id Form ID.

[12] Fix | Delete

* @param bool $title Form title.

[13] Fix | Delete

* @param bool $desc Form description.

[14] Fix | Delete

*/

[15] Fix | Delete

function wpforms_display( $form_id = false, $title = false, $desc = false ) {

[16] Fix | Delete

[17] Fix | Delete

$frontend = wpforms()->obj( 'frontend' );

[18] Fix | Delete

[19] Fix | Delete

if ( empty( $frontend ) ) {

[20] Fix | Delete

return;

[21] Fix | Delete

}

[22] Fix | Delete

[23] Fix | Delete

$frontend->output( $form_id, $title, $desc );

[24] Fix | Delete

}

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Return URL to form preview page.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 1.5.1

[30] Fix | Delete

*

[31] Fix | Delete

* @param int $form_id Form ID.

[32] Fix | Delete

* @param bool $new_window New window flag.

[33] Fix | Delete

*

[34] Fix | Delete

* @return string

[35] Fix | Delete

*/

[36] Fix | Delete

function wpforms_get_form_preview_url( $form_id, $new_window = false ) {

[37] Fix | Delete

[38] Fix | Delete

$url = add_query_arg(

[39] Fix | Delete

[

[40] Fix | Delete

'wpforms_form_preview' => absint( $form_id ),

[41] Fix | Delete

],

[42] Fix | Delete

home_url()

[43] Fix | Delete

);

[44] Fix | Delete

[45] Fix | Delete

if ( $new_window ) {

[46] Fix | Delete

$url = add_query_arg(

[47] Fix | Delete

[

[48] Fix | Delete

'new_window' => 1,

[49] Fix | Delete

],

[50] Fix | Delete

$url

[51] Fix | Delete

);

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

return $url;

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Perform json_decode and unslash.

[59] Fix | Delete

*

[60] Fix | Delete

* IMPORTANT: This function decodes the result of wpforms_encode() properly only if

[61] Fix | Delete

* wp_insert_post() or wp_update_post() were used after the data is encoded.

[62] Fix | Delete

* Both wp_insert_post() and wp_update_post() remove excessive slashes added by wpforms_encode().

[63] Fix | Delete

*

[64] Fix | Delete

* Using wpforms_decode() on wpforms_encode() result directly

[65] Fix | Delete

* (without using wp_insert_post() or wp_update_post() first) always returns null or false.

[66] Fix | Delete

*

[67] Fix | Delete

* The json_decode failure returns an empty array.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 1.0.0

[70] Fix | Delete

*

[71] Fix | Delete

* @param string $data Data to decode.

[72] Fix | Delete

*

[73] Fix | Delete

* @return array|false|null Empty array if json_decode fails, false if $data is empty, or decoded data.

[74] Fix | Delete

*/

[75] Fix | Delete

function wpforms_decode( $data ) {

[76] Fix | Delete

[77] Fix | Delete

if ( empty( $data ) ) {

[78] Fix | Delete

return false;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

$decoded_data = json_decode( $data, true );

[82] Fix | Delete

[83] Fix | Delete

// If json_decode fails, return an empty array to prevent possible fatal errors due to type mismatch.

[84] Fix | Delete

if ( json_last_error() !== JSON_ERROR_NONE ) {

[85] Fix | Delete

return [];

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

return wp_unslash( $decoded_data );

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Perform json_encode and wp_slash.

[93] Fix | Delete

*

[94] Fix | Delete

* IMPORTANT: This function adds excessive slashes to prevent data damage

[95] Fix | Delete

* by wp_insert_post() or wp_update_post() that use wp_unslash() on all the incoming data.

[96] Fix | Delete

*

[97] Fix | Delete

* Decoding the result of this function by wpforms_decode() directly

[98] Fix | Delete

* (without using wp_insert_post() or wp_update_post() first) always returns null or false.

[99] Fix | Delete

*

[100] Fix | Delete

* @since 1.3.1.3

[101] Fix | Delete

*

[102] Fix | Delete

* @param mixed $data Data to encode.

[103] Fix | Delete

*

[104] Fix | Delete

* @return string|false

[105] Fix | Delete

*/

[106] Fix | Delete

function wpforms_encode( $data = false ) {

[107] Fix | Delete

[108] Fix | Delete

if ( empty( $data ) ) {

[109] Fix | Delete

return false;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

return wp_slash( wp_json_encode( $data ) );

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Decode json-encoded string if it is in JSON format.

[117] Fix | Delete

*

[118] Fix | Delete

* @since 1.7.5

[119] Fix | Delete

*

[120] Fix | Delete

* @param string $encoded_string A string.

[121] Fix | Delete

* @param bool $associative Decode to the associative array if true. Decode to object if false.

[122] Fix | Delete

*

[123] Fix | Delete

* @return array|string

[124] Fix | Delete

*/

[125] Fix | Delete

function wpforms_json_decode( $encoded_string, $associative = false ) {

[126] Fix | Delete

[127] Fix | Delete

$encoded_string = html_entity_decode( $encoded_string );

[128] Fix | Delete

[129] Fix | Delete

if ( ! wpforms_is_json( $encoded_string ) ) {

[130] Fix | Delete

return $encoded_string;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

return json_decode( $encoded_string, $associative );

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Get the value of a specific WPForms setting.

[138] Fix | Delete

*

[139] Fix | Delete

* @since 1.0.0

[140] Fix | Delete

*

[141] Fix | Delete

* @param string $key Setting name.

[142] Fix | Delete

* @param mixed $default_value Default value to return if the setting is not available.

[143] Fix | Delete

* @param string $option Option key, defaults to `wpforms_settings` in the `wp_options` table.

[144] Fix | Delete

*

[145] Fix | Delete

* @return mixed

[146] Fix | Delete

*/

[147] Fix | Delete

function wpforms_setting( $key, $default_value = false, $option = 'wpforms_settings' ) {

[148] Fix | Delete

[149] Fix | Delete

$key = wpforms_sanitize_key( $key );

[150] Fix | Delete

$options = get_option( $option, false );

[151] Fix | Delete

$value = is_array( $options ) && ! empty( $options[ $key ] ) ? wp_unslash( $options[ $key ] ) : $default_value;

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Allows plugin setting to be modified.

[155] Fix | Delete

*

[156] Fix | Delete

* @since 1.7.8

[157] Fix | Delete

*

[158] Fix | Delete

* @param mixed $value Setting value.

[159] Fix | Delete

* @param string $key Setting key.

[160] Fix | Delete

* @param mixed $default_value Setting default value.

[161] Fix | Delete

* @param string $option Settings option name.

[162] Fix | Delete

*/

[163] Fix | Delete

return apply_filters( 'wpforms_setting', $value, $key, $default_value, $option );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Update the plugin settings option and allow it to be filterable.

[168] Fix | Delete

*

[169] Fix | Delete

* The purpose of this function is to save settings when the "Save Settings" button is clicked.

[170] Fix | Delete

* If you are programmatically saving setting in the database in cases not triggered by user,

[171] Fix | Delete

* use update_option() instead.

[172] Fix | Delete

*

[173] Fix | Delete

* @since 1.6.6

[174] Fix | Delete

*

[175] Fix | Delete

* @param array $settings A plugin settings array that is saved into option table.

[176] Fix | Delete

*

[177] Fix | Delete

* @return bool

[178] Fix | Delete

*/

[179] Fix | Delete

function wpforms_update_settings( $settings ) {

[180] Fix | Delete

[181] Fix | Delete

$old_settings = (array) get_option( 'wpforms_settings', [] );

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Allows plugin settings to be modified before persisting in the database.

[185] Fix | Delete

*

[186] Fix | Delete

* @since 1.6.6

[187] Fix | Delete

*

[188] Fix | Delete

* @param array $settings An array of plugin settings to modify.

[189] Fix | Delete

*/

[190] Fix | Delete

$settings = (array) apply_filters( 'wpforms_update_settings', $settings );

[191] Fix | Delete

[192] Fix | Delete

$updated = update_option( 'wpforms_settings', $settings );

[193] Fix | Delete

[194] Fix | Delete

/**

[195] Fix | Delete

* Fires after the plugin settings were persisted in the database.

[196] Fix | Delete

*

[197] Fix | Delete

* The `$updated` parameter allows to check whether the update was actually successful.

[198] Fix | Delete

*

[199] Fix | Delete

* @since 1.6.1

[200] Fix | Delete

* @since 1.8.4 The `$old_settings` parameter was added.

[201] Fix | Delete

*

[202] Fix | Delete

* @param array $settings An array of plugin settings.

[203] Fix | Delete

* @param bool $updated Whether an option was updated or not.

[204] Fix | Delete

* @param array $old_settings An old array of plugin settings.

[205] Fix | Delete

*/

[206] Fix | Delete

do_action( 'wpforms_settings_updated', $settings, $updated, $old_settings );

[207] Fix | Delete

[208] Fix | Delete

return $updated;

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Check an if form provided contains the specified field type.

[213] Fix | Delete

*

[214] Fix | Delete

* @since 1.0.5

[215] Fix | Delete

*

[216] Fix | Delete

* @param array|string $type Field type or types.

[217] Fix | Delete

* @param array|object $form Form data object.

[218] Fix | Delete

* @param bool $multiple Whether to check multiple field types.

[219] Fix | Delete

*

[220] Fix | Delete

* @return bool

[221] Fix | Delete

*/

[222] Fix | Delete

function wpforms_has_field_type( $type, $form, $multiple = false ) {

[223] Fix | Delete

[224] Fix | Delete

$form_data = '';

[225] Fix | Delete

$field = false;

[226] Fix | Delete

$type = (array) $type;

[227] Fix | Delete

[228] Fix | Delete

if ( $multiple ) {

[229] Fix | Delete

foreach ( $form as $single_form ) {

[230] Fix | Delete

$field = wpforms_has_field_type( $type, $single_form );

[231] Fix | Delete

[232] Fix | Delete

if ( $field ) {

[233] Fix | Delete

break;

[234] Fix | Delete

}

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

return $field;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

if ( is_object( $form ) && ! empty( $form->post_content ) ) {

[241] Fix | Delete

$form_data = wpforms_decode( $form->post_content );

[242] Fix | Delete

} elseif ( is_array( $form ) ) {

[243] Fix | Delete

$form_data = $form;

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

if ( empty( $form_data['fields'] ) ) {

[247] Fix | Delete

return false;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

foreach ( $form_data['fields'] as $single_field ) {

[251] Fix | Delete

if ( ! empty( $single_field['type'] ) && in_array( $single_field['type'], $type, true ) ) {

[252] Fix | Delete

$field = true;

[253] Fix | Delete

[254] Fix | Delete

break;

[255] Fix | Delete

}

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

return $field;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Check if the form provided contains a field which a specific setting.

[263] Fix | Delete

*

[264] Fix | Delete

* @since 1.4.5

[265] Fix | Delete

*

[266] Fix | Delete

* @param string $setting Setting key.

[267] Fix | Delete

* @param object|array $form Form data.

[268] Fix | Delete

* @param bool $multiple Whether to check multiple settings.

[269] Fix | Delete

*

[270] Fix | Delete

* @return bool

[271] Fix | Delete

*/

[272] Fix | Delete

function wpforms_has_field_setting( $setting, $form, $multiple = false ) {

[273] Fix | Delete

[274] Fix | Delete

$form_data = '';

[275] Fix | Delete

$field = false;

[276] Fix | Delete

[277] Fix | Delete

if ( $multiple ) {

[278] Fix | Delete

foreach ( $form as $single_form ) {

[279] Fix | Delete

$field = wpforms_has_field_setting( $setting, $single_form );

[280] Fix | Delete

[281] Fix | Delete

if ( $field ) {

[282] Fix | Delete

break;

[283] Fix | Delete

}

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

return $field;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

if ( is_object( $form ) && ! empty( $form->post_content ) ) {

[290] Fix | Delete

$form_data = wpforms_decode( $form->post_content );

[291] Fix | Delete

} elseif ( is_array( $form ) ) {

[292] Fix | Delete

$form_data = $form;

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

if ( empty( $form_data['fields'] ) ) {

[296] Fix | Delete

return false;

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

foreach ( $form_data['fields'] as $single_field ) {

[300] Fix | Delete

[301] Fix | Delete

if ( ! empty( $single_field[ $setting ] ) ) {

[302] Fix | Delete

$field = true;

[303] Fix | Delete

[304] Fix | Delete

break;

[305] Fix | Delete

}

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

return $field;

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

/**

[312] Fix | Delete

* Retrieve actual fields from a form.

[313] Fix | Delete

*

[314] Fix | Delete

* Non-posting elements such as section divider, page break, and HTML are

[315] Fix | Delete

* automatically excluded. Optionally, a whitelist can be provided.

[316] Fix | Delete

*

[317] Fix | Delete

* @since 1.0.0

[318] Fix | Delete

*

[319] Fix | Delete

* @param mixed $form Form data.

[320] Fix | Delete

* @param array $allowlist A list of allowed fields.

[321] Fix | Delete

*

[322] Fix | Delete

* @return mixed boolean false or array

[323] Fix | Delete

*/

[324] Fix | Delete

function wpforms_get_form_fields( $form = false, $allowlist = [] ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh, Generic.Metrics.NestingLevel.MaxExceeded

[325] Fix | Delete

[326] Fix | Delete

// Accept form (post) object or form ID.

[327] Fix | Delete

if ( is_object( $form ) ) {

[328] Fix | Delete

$form = wpforms_decode( $form->post_content );

[329] Fix | Delete

} elseif ( is_numeric( $form ) ) {

[330] Fix | Delete

$form = wpforms()->obj( 'form' )->get(

[331] Fix | Delete

absint( $form ),

[332] Fix | Delete

[

[333] Fix | Delete

'content_only' => true,

[334] Fix | Delete

]

[335] Fix | Delete

);

[336] Fix | Delete

}

[337] Fix | Delete

[338] Fix | Delete

$allowed_form_fields = [

[339] Fix | Delete

'address',

[340] Fix | Delete

'checkbox',

[341] Fix | Delete

'date-time',

[342] Fix | Delete

'email',

[343] Fix | Delete

'file-upload',

[344] Fix | Delete

'gdpr-checkbox',

[345] Fix | Delete

'hidden',

[346] Fix | Delete

'likert_scale',

[347] Fix | Delete

'name',

[348] Fix | Delete

'net_promoter_score',

[349] Fix | Delete

'number',

[350] Fix | Delete

'number-slider',

[351] Fix | Delete

'payment-checkbox',

[352] Fix | Delete

'payment-multiple',

[353] Fix | Delete

'payment-select',

[354] Fix | Delete

'payment-single',

[355] Fix | Delete

'payment-total',

[356] Fix | Delete

'phone',

[357] Fix | Delete

'radio',

[358] Fix | Delete

'rating',

[359] Fix | Delete

'richtext',

[360] Fix | Delete

'select',

[361] Fix | Delete

'signature',

[362] Fix | Delete

'text',

[363] Fix | Delete

'textarea',

[364] Fix | Delete

'url',

[365] Fix | Delete

];

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Filter the list of allowed form fields.

[369] Fix | Delete

*

[370] Fix | Delete

* @since 1.0.0

[371] Fix | Delete

*

[372] Fix | Delete

* @param array $allowed_form_fields List of allowed form fields.

[373] Fix | Delete

*/

[374] Fix | Delete

$allowed_form_fields = (array) apply_filters( 'wpforms_get_form_fields_allowed', $allowed_form_fields );

[375] Fix | Delete

[376] Fix | Delete

if ( ! is_array( $form ) || empty( $form['fields'] ) ) {

[377] Fix | Delete

return false;

[378] Fix | Delete

}

[379] Fix | Delete

[380] Fix | Delete

$allowlist = ! empty( $allowlist ) ? $allowlist : $allowed_form_fields;

[381] Fix | Delete

[382] Fix | Delete

$form_fields = $form['fields'];

[383] Fix | Delete

[384] Fix | Delete

foreach ( $form_fields as $id => $form_field ) {

[385] Fix | Delete

// Remove repeater field and its children.

[386] Fix | Delete

if ( $form_field['type'] === 'repeater' ) {

[387] Fix | Delete

foreach ( (array) $form_field['columns'] as $column ) {

[388] Fix | Delete

$column_fields = $column['fields'] ?? [];

[389] Fix | Delete

[390] Fix | Delete

foreach ( $column_fields as $field_id ) {

[391] Fix | Delete

unset( $form_fields[ $field_id ] );

[392] Fix | Delete

}

[393] Fix | Delete

}

[394] Fix | Delete

}

[395] Fix | Delete

[396] Fix | Delete

if ( ! in_array( $form_field['type'], $allowlist, true ) ) {

[397] Fix | Delete

unset( $form_fields[ $id ] );

[398] Fix | Delete

}

[399] Fix | Delete

}

[400] Fix | Delete

[401] Fix | Delete

return $form_fields;

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

/**

[405] Fix | Delete

* Conditional logic form fields supported.

[406] Fix | Delete

*

[407] Fix | Delete

* @since 1.5.2

[408] Fix | Delete

*

[409] Fix | Delete

* @return array

[410] Fix | Delete

*/

[411] Fix | Delete

function wpforms_get_conditional_logic_form_fields_supported() {

[412] Fix | Delete

[413] Fix | Delete

$fields_supported = [

[414] Fix | Delete

'checkbox',

[415] Fix | Delete

'email',

[416] Fix | Delete

'hidden',

[417] Fix | Delete

'net_promoter_score',

[418] Fix | Delete

'number',

[419] Fix | Delete

'number-slider',

[420] Fix | Delete

'payment-checkbox',

[421] Fix | Delete

'payment-multiple',

[422] Fix | Delete

'payment-select',

[423] Fix | Delete

'radio',

[424] Fix | Delete

'rating',

[425] Fix | Delete

'richtext',

[426] Fix | Delete

'select',

[427] Fix | Delete

'text',

[428] Fix | Delete

'textarea',

[429] Fix | Delete

'url',

[430] Fix | Delete

];

[431] Fix | Delete

[432] Fix | Delete

/**

[433] Fix | Delete

* Filter the list of form fields supported by conditional logic.

[434] Fix | Delete

*

[435] Fix | Delete

* @since 1.8.0

[436] Fix | Delete

*

[437] Fix | Delete

* @param array $fields_supported List of form fields supported by conditional logic.

[438] Fix | Delete

*/

[439] Fix | Delete

return apply_filters( 'wpforms_get_conditional_logic_form_fields_supported', $fields_supported );

[440] Fix | Delete

}

[441] Fix | Delete

[442] Fix | Delete

/**

[443] Fix | Delete

* Get meta key value for a form field.

[444] Fix | Delete

*

[445] Fix | Delete

* @since 1.3.1

[446] Fix | Delete

* @since 1.5.0 More strict parameters. Always return an array.

[447] Fix | Delete

*

[448] Fix | Delete

* @param string $key Meta key.

[449] Fix | Delete

* @param string $value Meta value to check against.

[450] Fix | Delete

* @param array $form_data Form data array.

[451] Fix | Delete

*

[452] Fix | Delete

* @return array Empty array, when no data is found.

[453] Fix | Delete

*/

[454] Fix | Delete

function wpforms_get_form_fields_by_meta( $key, $value, $form_data ) {

[455] Fix | Delete

[456] Fix | Delete

$found = [];

[457] Fix | Delete

[458] Fix | Delete

if ( empty( $key ) || empty( $value ) || empty( $form_data['fields'] ) ) {

[459] Fix | Delete

return $found;

[460] Fix | Delete

}

[461] Fix | Delete

[462] Fix | Delete

foreach ( $form_data['fields'] as $id => $field ) {

[463] Fix | Delete

[464] Fix | Delete

if ( ! empty( $field['meta'][ $key ] ) && $value === $field['meta'][ $key ] ) {

[465] Fix | Delete

$found[ $id ] = $field;

[466] Fix | Delete

}

[467] Fix | Delete

}

[468] Fix | Delete

[469] Fix | Delete

return $found;

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

/**

[473] Fix | Delete

* Retrieve the full config for CAPTCHA.

[474] Fix | Delete

*

[475] Fix | Delete

* @since 1.6.4

[476] Fix | Delete

*

[477] Fix | Delete

* @return array

[478] Fix | Delete

*/

[479] Fix | Delete

function wpforms_get_captcha_settings() {

[480] Fix | Delete

[481] Fix | Delete

$allowed_captcha_list = [ 'hcaptcha', 'recaptcha', 'turnstile' ];

[482] Fix | Delete

$captcha_provider = wpforms_setting( 'captcha-provider', 'recaptcha' );

[483] Fix | Delete

[484] Fix | Delete

if ( ! in_array( $captcha_provider, $allowed_captcha_list, true ) ) {

[485] Fix | Delete

return [

[486] Fix | Delete

'provider' => 'none',

[487] Fix | Delete

];

[488] Fix | Delete

}

[489] Fix | Delete

[490] Fix | Delete

return [

[491] Fix | Delete

'provider' => $captcha_provider,

[492] Fix | Delete

'site_key' => sanitize_text_field( wpforms_setting( "{$captcha_provider}-site-key", '' ) ),

[493] Fix | Delete

'secret_key' => sanitize_text_field( wpforms_setting( "{$captcha_provider}-secret-key", '' ) ),

[494] Fix | Delete

'recaptcha_type' => wpforms_setting( 'recaptcha-type', 'v2' ),

[495] Fix | Delete

'theme' => sanitize_text_field( wpforms_setting( "{$captcha_provider}-theme", '' ) ),

[496] Fix | Delete

];

[497] Fix | Delete

}

[498] Fix | Delete

[499] Fix | Delete