PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 5.0
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v5.0
6.35 6.34 6.33.1 6.33 6.32.1 6.32 6.31 6.25 6.25.1 6.26 6.26.1 6.27 6.28 6.29 6.3 6.3.1 6.3.2 6.30 6.4 6.4.1 6.4.2 6.5 6.5.1 6.5.2 6.5.3 All 141 releases
← All changes | classes/models/FrmFieldFormHtml.php +48 -219 6.295.0 View file →
@@ -5,18 +5,13 @@
5 5
6 6 /**
7 7 * @since 3.0
8 8 */
9 +
9 10 class FrmFieldFormHtml {
10 11
11 - /**
12 - * @var string
13 - */
14 12 private $html;
15 13
16 - /**
17 - * @var string
18 - */
19 14 private $html_id;
20 15
21 16 /**
22 17 * @var FrmFieldType
@@ -22,21 +17,12 @@
22 17 * @var FrmFieldType
23 18 */
24 19 private $field_obj;
25 20
26 - /**
27 - * @var int|string
28 - */
29 21 private $field_id;
30 22
31 - /**
32 - * @var array|object
33 - */
34 23 private $form = array();
35 24
36 - /**
37 - * @var array
38 - */
39 25 private $pass_args = array();
40 26
41 27 /**
42 28 * @since 3.0
@@ -55,11 +41,9 @@
55 41 /**
56 42 * @since 3.0
57 43 *
58 44 * @param string $param
59 - * @param array $atts
60 - *
61 - * @return void
45 + * @param array $atts
62 46 */
63 47 private function _set( $param, $atts ) {
64 48 if ( isset( $atts[ $param ] ) ) {
65 49 $this->{$param} = $atts[ $param ];
@@ -69,10 +53,8 @@
69 53 /**
70 54 * @since 3.0
71 55 *
72 56 * @param array $atts
73 - *
74 - * @return void
75 57 */
76 58 private function set_html( $atts ) {
77 59 $this->set_from_field(
78 60 $atts,
@@ -86,10 +68,8 @@
86 68 /**
87 69 * @since 3.0
88 70 *
89 71 * @param array $atts
90 - *
91 - * @return void
92 72 */
93 73 private function set_field_id( $atts ) {
94 74 $this->set_from_field(
95 75 $atts,
@@ -103,16 +83,13 @@
103 83 /**
104 84 * @since 3.0
105 85 *
106 86 * @param array $atts
107 - *
108 - * @return void
109 87 */
110 88 private function set_pass_args( $atts ) {
111 89 $this->pass_args = $atts;
112 90
113 91 $exclude = array( 'field_obj', 'html' );
114 -
115 92 foreach ( $exclude as $ex ) {
116 93 if ( isset( $atts[ $ex ] ) ) {
117 94 unset( $this->pass_args[ $ex ] );
118 95 }
@@ -123,10 +100,8 @@
123 100 * @since 3.0
124 101 *
125 102 * @param array $atts
126 103 * @param array $set
127 - *
128 - * @return void
129 104 */
130 105 private function set_from_field( $atts, $set ) {
131 106 if ( isset( $atts[ $set['param'] ] ) ) {
132 107 $this->{$set['param']} = $atts[ $set['param'] ];
@@ -134,11 +109,8 @@
134 109 $this->{$set['param']} = $this->field_obj->get_field_column( $set['default'] );
135 110 }
136 111 }
137 112
138 - /**
139 - * @return string
140 - */
141 113 public function get_html() {
142 114 $this->replace_shortcodes_before_input();
143 115 $this->replace_shortcodes_with_atts();
144 116 $this->replace_shortcodes_after_input();
@@ -147,10 +119,8 @@
147 119 }
148 120
149 121 /**
150 122 * @since 3.0
151 - *
152 - * @return void
153 123 */
154 124 private function replace_shortcodes_before_input() {
155 125 $this->html = apply_filters( 'frm_before_replace_shortcodes', $this->html, $this->field_obj->get_field(), $this->pass_args['errors'], $this->form );
156 126
@@ -166,35 +136,29 @@
166 136 $this->replace_entry_key();
167 137 $this->replace_form_shortcodes();
168 138 $this->process_wp_shortcodes();
169 139 $this->maybe_replace_description_shortcode( true );
170 -
171 - $this->add_multiple_input_attributes();
172 140 }
173 141
174 142 /**
175 143 * @since 3.0
176 - *
177 - * @return void
178 144 */
179 145 private function replace_field_values() {
180 - // Replace [id].
146 + //replace [id]
181 147 $this->html = str_replace( '[id]', $this->field_id, $this->html );
182 148
183 - // Set the label for
149 + // set the label for
184 150 $this->html = str_replace( 'field_[key]', $this->html_id, $this->html );
185 151
186 - // Replace [key].
152 + //replace [key]
187 153 $this->html = str_replace( '[key]', $this->field_obj->get_field_column( 'field_key' ), $this->html );
188 154
189 - // Replace [field_name].
190 - $this->html = str_replace( '[field_name]', FrmAppHelper::maybe_kses( $this->field_obj->get_field_column( 'name' ) ), $this->html );
155 + //replace [field_name]
156 + $this->html = str_replace( '[field_name]', $this->field_obj->get_field_column( 'name' ), $this->html );
191 157 }
192 158
193 159 /**
194 160 * @since 3.0
195 - *
196 - * @return void
197 161 */
198 162 private function replace_required_label_shortcode() {
199 163 $required = FrmField::is_required( $this->field_obj->get_field() ) ? $this->field_obj->get_field_column( 'required_indicator' ) : '';
200 164 FrmShortcodeHelper::remove_inline_conditions( ! empty( $required ), 'required_label', $required, $this->html );
@@ -204,17 +168,12 @@
204 168 * If this is an HTML field, the values are included in the description.
205 169 * In this case, we don't want to run the wp shortcodes with the description included.
206 170 *
207 171 * @since 3.0
208 - *
209 - * @param bool $wp_processed
210 - *
211 - * @return void
212 172 */
213 173 private function maybe_replace_description_shortcode( $wp_processed = false ) {
214 174 $is_html = 'html' === $this->field_obj->get_field_column( 'type' );
215 - $should_replace = $is_html ? $wp_processed : ! $wp_processed;
216 -
175 + $should_replace = ( $is_html && $wp_processed ) || ( ! $is_html && ! $wp_processed );
217 176 if ( $should_replace ) {
218 177 $this->replace_description_shortcode();
219 178 }
220 179 }
@@ -220,16 +179,13 @@
220 179 }
221 180
222 181 /**
223 182 * @since 3.0
224 - *
225 - * @return void
226 183 */
227 184 private function replace_description_shortcode() {
228 185 $this->maybe_add_description_id();
229 - $description = FrmAppHelper::maybe_kses( $this->field_obj->get_field_column( 'description' ) );
230 - // phpcs:ignore Universal.Operators.StrictComparisons
231 - FrmShortcodeHelper::remove_inline_conditions( $description && $description != '', 'description', $description, $this->html );
186 + $description = $this->field_obj->get_field_column( 'description' );
187 + FrmShortcodeHelper::remove_inline_conditions( ( $description && $description != '' ), 'description', $description, $this->html );
232 188 }
233 189
234 190 /**
235 191 * Add an ID to the description for aria-describedby.
@@ -235,15 +191,11 @@
235 191 * Add an ID to the description for aria-describedby.
236 192 * This ID was added to the HTML in v3.0.
237 193 *
238 194 * @since 3.0
239 - *
240 - * @return void
241 195 */
242 196 private function maybe_add_description_id() {
243 197 $description = $this->field_obj->get_field_column( 'description' );
244 -
245 - // phpcs:ignore Universal.Operators.StrictComparisons
246 198 if ( $description != '' ) {
247 199 $this->add_element_id( 'description', 'desc' );
248 200 }
249 201 }
@@ -251,17 +203,11 @@
251 203 /**
252 204 * Insert an ID if it doesn't exist.
253 205 *
254 206 * @since 3.06.02
255 - *
256 - * @param string $param
257 - * @param string $id
258 - *
259 - * @return void
260 207 */
261 208 private function add_element_id( $param, $id ) {
262 209 preg_match_all( '/(\[if\s+' . $param . '\])(.*?)(\[\/if\s+' . $param . '\])/mis', $this->html, $inner_html );
263 -
264 210 if ( ! isset( $inner_html[2] ) ) {
265 211 return;
266 212 }
267 213
@@ -268,73 +214,31 @@
268 214 if ( ! is_string( $inner_html[2] ) && count( $inner_html[2] ) === 1 ) {
269 215 $inner_html[2] = $inner_html[2][0];
270 216 }
271 217
272 - if ( ! is_string( $inner_html[2] ) ) {
273 - return;
218 + if ( is_string( $inner_html[2] ) ) {
219 + $has_id = strpos( $inner_html[2], ' id=' );
220 + if ( ! $has_id ) {
221 + $id = 'frm_' . $id . '_' . $this->html_id;
222 + $this->html = str_replace( 'class="frm_' . $param, 'id="' . esc_attr( $id ) . '" class="frm_' . esc_attr( $param ), $this->html );
223 + }
274 224 }
275 -
276 - $has_id = str_contains( $inner_html[2], ' id=' );
277 -
278 - if ( $has_id ) {
279 - return;
280 - }
281 -
282 - $id = 'frm_' . $id . '_' . $this->html_id;
283 - $this->html = str_replace( 'class="frm_' . $param, 'id="' . esc_attr( $id ) . '" class="frm_' . esc_attr( $param ), $this->html );
284 225 }
285 226
286 227 /**
287 228 * @since 3.0
288 - *
289 - * @return void
290 229 */
291 230 private function replace_error_shortcode() {
292 231 $this->maybe_add_error_id();
293 - $error = $this->pass_args['errors'][ 'field' . $this->field_id ] ?? false;
294 -
295 - if ( $error && ! str_contains( $this->html, 'role="alert"' ) && FrmAppHelper::should_include_alert_role_on_field_errors() ) {
296 - $error_body = self::get_error_body( $this->html );
297 -
298 - if ( is_string( $error_body ) && ! str_contains( $error_body, 'role=' ) ) {
299 - $new_error_body = preg_replace( '/class="frm_error/', 'role="alert" class="frm_error', $error_body, 1 );
300 - $this->html = str_replace( '[if error]' . $error_body . '[/if error]', '[if error]' . $new_error_body . '[/if error]', $this->html );
301 - }
302 - }
303 -
232 + $error = isset( $this->pass_args['errors'][ 'field' . $this->field_id ] ) ? $this->pass_args['errors'][ 'field' . $this->field_id ] : false;
304 233 FrmShortcodeHelper::remove_inline_conditions( ! empty( $error ), 'error', $error, $this->html );
305 234 }
306 235
307 236 /**
308 - * Pull the HTML between [if error] and [/if error] shortcodes.
309 - *
310 - * @param string $html
311 - *
312 - * @return false|string
313 - */
314 - private static function get_error_body( $html ) {
315 - $start = strpos( $html, '[if error]' );
316 -
317 - if ( false === $start ) {
318 - return false;
319 - }
320 -
321 - $end = strpos( $html, '[/if error]', $start );
322 -
323 - if ( false === $end ) {
324 - return false;
325 - }
326 -
327 - return substr( $html, $start + 10, $end - $start - 10 );
328 - }
329 -
330 - /**
331 237 * Add an ID to the error message for aria-describedby.
332 238 * This ID was added to the HTML in v3.06.02.
333 239 *
334 240 * @since 3.06.02
335 - *
336 - * @return void
337 241 */
338 242 private function maybe_add_error_id() {
339 243 if ( ! isset( $this->pass_args['errors'][ 'field' . $this->field_id ] ) ) {
340 244 return;
@@ -346,10 +250,8 @@
346 250 /**
347 251 * Replace [required_class]
348 252 *
349 253 * @since 3.0
350 - *
351 - * @return void
352 254 */
353 255 private function replace_required_class() {
354 256 $required_class = FrmField::is_required( $this->field_obj->get_field() ) ? ' frm_required_field' : '';
355 257 $this->html = str_replace( '[required_class]', $required_class, $this->html );
@@ -356,35 +258,29 @@
356 258 }
357 259
358 260 /**
359 261 * @since 3.0
360 - *
361 - * @return void
362 262 */
363 263 private function replace_form_shortcodes() {
364 - if ( ! $this->form ) {
365 - return;
366 - }
264 + if ( ! empty( $this->form ) ) {
265 + $form = (array) $this->form;
367 266
368 - $form = (array) $this->form;
267 + //replace [form_key]
268 + $this->html = str_replace( '[form_key]', $form['form_key'], $this->html );
369 269
370 - // Replace [form_key].
371 - $this->html = str_replace( '[form_key]', $form['form_key'], $this->html );
372 -
373 - // Replace [form_name].
374 - $this->html = str_replace( '[form_name]', $form['name'], $this->html );
270 + //replace [form_name]
271 + $this->html = str_replace( '[form_name]', $form['name'], $this->html );
272 + }
375 273 }
376 274
377 275 /**
378 276 * @since 3.0
379 - *
380 - * @return void
381 277 */
382 278 public function replace_shortcodes_after_input() {
383 279 $this->html .= "\n";
384 280
385 281 // Stop html filtering on confirmation field to prevent loop
386 - if ( $this->field_obj->get_field_column( 'conf_field' ) !== 'stop' ) {
282 + if ( $this->field_obj->get_field_column( 'conf_field' ) != 'stop' ) {
387 283 $this->filter_for_more_shortcodes();
388 284 }
389 285 }
390 286
@@ -389,15 +285,13 @@
389 285 }
390 286
391 287 /**
392 288 * @since 3.0
393 - *
394 - * @return void
395 289 */
396 290 private function filter_for_more_shortcodes() {
397 291 $atts = $this->pass_args;
398 292
399 - // If field is not in repeating section.
293 + //If field is not in repeating section
400 294 if ( empty( $atts['section_id'] ) ) {
401 295 $atts = array(
402 296 'errors' => $this->pass_args['errors'],
403 297 'form' => $this->form,
@@ -411,13 +305,11 @@
411 305 *
412 306 * @since 3.0
413 307 *
414 308 * @param string $html
415 - *
416 - * @return void
417 309 */
418 310 public function remove_collapse_shortcode( &$html ) {
419 - if ( str_contains( $html, '[collapse_this]' ) ) {
311 + if ( strpos( $html, '[collapse_this]' ) ) {
420 312 $html = str_replace( '[collapse_this]', '', $html );
421 313 }
422 314 }
423 315
@@ -422,10 +314,8 @@
422 314 }
423 315
424 316 /**
425 317 * @since 3.0
426 - *
427 - * @return void
428 318 */
429 319 private function replace_shortcodes_with_atts() {
430 320 preg_match_all( "/\[(input|deletelink)\b(.*?)(?:(\/))?\]/s", $this->html, $shortcodes, PREG_PATTERN_ORDER );
431 321
@@ -431,13 +321,14 @@
431 321
432 322 foreach ( $shortcodes[0] as $short_key => $tag ) {
433 323 $shortcode_atts = FrmShortcodeHelper::get_shortcode_attribute_array( $shortcodes[2][ $short_key ] );
434 324 $tag = FrmShortcodeHelper::get_shortcode_tag( $shortcodes, $short_key );
435 - $replace_with = '';
436 325
437 - if ( $tag === 'deletelink' && FrmAppHelper::pro_is_installed() ) {
326 + $replace_with = '';
327 +
328 + if ( $tag == 'deletelink' && FrmAppHelper::pro_is_installed() ) {
438 329 $replace_with = FrmProEntriesController::entry_delete_link( $shortcode_atts );
439 - } elseif ( $tag === 'input' ) {
330 + } elseif ( $tag == 'input' ) {
440 331 $replace_with = $this->replace_input_shortcode( $shortcode_atts );
441 332 }
442 333
443 334 $this->html = str_replace( $shortcodes[0][ $short_key ], $replace_with, $this->html );
@@ -450,8 +341,9 @@
450 341 * @return string
451 342 */
452 343 private function replace_input_shortcode( $shortcode_atts ) {
453 344 $shortcode_atts = $this->prepare_input_shortcode_atts( $shortcode_atts );
345 +
454 346 return $this->field_obj->include_front_field_input( $this->pass_args, $shortcode_atts );
455 347 }
456 348
457 349 /**
@@ -460,12 +352,12 @@
460 352 * @return array
461 353 */
462 354 private function prepare_input_shortcode_atts( $shortcode_atts ) {
463 355 if ( isset( $shortcode_atts['opt'] ) ) {
464 - --$shortcode_atts['opt'];
356 + $shortcode_atts['opt'] --;
465 357 }
466 358
467 - $field_class = $shortcode_atts['class'] ?? '';
359 + $field_class = isset( $shortcode_atts['class'] ) ? $shortcode_atts['class'] : '';
468 360 $this->field_obj->set_field_column( 'input_class', $field_class );
469 361
470 362 if ( isset( $shortcode_atts['class'] ) ) {
471 363 unset( $shortcode_atts['class'] );
@@ -470,9 +362,9 @@
470 362 if ( isset( $shortcode_atts['class'] ) ) {
471 363 unset( $shortcode_atts['class'] );
472 364 }
473 365
474 - $this->field_obj->set_aria_invalid_error( $shortcode_atts, $this->pass_args );
366 + $shortcode_atts['aria-invalid'] = isset( $this->pass_args['errors'][ 'field' . $this->field_id ] ) ? 'true' : 'false';
475 367
476 368 $this->field_obj->set_field_column( 'shortcodes', $shortcode_atts );
477 369
478 370 return $shortcode_atts;
@@ -482,14 +374,15 @@
482 374 * Add the label position class into the HTML
483 375 * If the label position is inside, add a class to show the label if the field has a value.
484 376 *
485 377 * @since 3.0
486 - *
487 - * @return void
488 378 */
489 379 private function add_class_to_label() {
490 380 $label_class = $this->field_obj->get_label_class();
491 381 $this->html = str_replace( '[label_position]', $label_class, $this->html );
382 + if ( $this->field_obj->get_field_column( 'label' ) == 'inside' && $this->field_obj->get_field_column( 'value' ) != '' ) {
383 + $this->html = str_replace( 'frm_primary_label', 'frm_primary_label frm_visible', $this->html );
384 + }
492 385 }
493 386
494 387 /**
495 388 * Replace [entry_key]
@@ -494,10 +387,8 @@
494 387 /**
495 388 * Replace [entry_key]
496 389 *
497 390 * @since 3.0
498 - *
499 - * @return void
500 391 */
501 392 private function replace_entry_key() {
502 393 $entry_key = FrmAppHelper::simple_get( 'entry', 'sanitize_title' );
503 394 $this->html = str_replace( '[entry_key]', $entry_key, $this->html );
@@ -506,21 +397,17 @@
506 397 /**
507 398 * Add classes to a field div
508 399 *
509 400 * @since 3.0
510 - *
511 - * @return void
512 401 */
513 402 private function add_field_div_classes() {
514 403 $classes = $this->get_field_div_classes();
515 404
516 - if ( in_array( $this->field_obj->get_field_column( 'type' ), array( 'html', 'summary' ), true ) && ! str_contains( $this->html, '[error_class]' ) ) {
517 - // There is no error_class shortcode for HTML fields
518 - $this->html = str_replace( 'class="frm_form_field', 'class="frm_form_field ' . esc_attr( $classes ), $this->html );
519 - return;
405 + if ( $this->field_obj->get_field_column( 'type' ) == 'html' && strpos( $this->html, '[error_class]' ) === false ) {
406 + // there is no error_class shortcode for HTML fields
407 + $this->html = str_replace( 'class="frm_form_field', 'class="frm_form_field ' . $classes, $this->html );
520 408 }
521 -
522 - $this->html = str_replace( '[error_class]', esc_attr( $classes ), $this->html );
409 + $this->html = str_replace( '[error_class]', $classes, $this->html );
523 410 }
524 411
525 412 /**
526 413 * Get the classes for a field div
@@ -526,9 +413,9 @@
526 413 * Get the classes for a field div
527 414 *
528 415 * @since 3.0
529 416 *
530 - * @return string Classes.
417 + * @return string $classes
531 418 */
532 419 private function get_field_div_classes() {
533 420 // Add error class
534 421 $classes = isset( $this->pass_args['errors'][ 'field' . $this->field_id ] ) ? ' frm_blank_field' : '';
@@ -534,27 +421,18 @@
534 421 $classes = isset( $this->pass_args['errors'][ 'field' . $this->field_id ] ) ? ' frm_blank_field' : '';
535 422
536 423 // Add label position class
537 424 $settings = $this->field_obj->display_field_settings();
538 -
539 - if ( ! empty( $settings['label_position'] ) ) {
540 - $label_position = $this->field_obj->get_field_column( 'label' );
541 - $classes .= ' frm_' . $label_position . '_container';
542 -
543 - // Add class if field has value, to be used for floating label styling.
544 - if ( 'inside' === $label_position && $this->field_obj->get_field_column( 'value' ) ) {
545 - $classes .= ' frm_label_float_top';
546 - }
425 + if ( isset( $settings['label_position'] ) && $settings['label_position'] ) {
426 + $classes .= ' frm_' . $this->field_obj->get_field_column( 'label' ) . '_container';
547 427 }
548 428
549 429 // Add CSS layout classes
550 430 $extra_classes = $this->field_obj->get_field_column( 'classes' );
551 -
552 - if ( $extra_classes ) {
553 - if ( ! str_contains( $this->html, 'frm_form_field ' ) ) {
431 + if ( ! empty( $extra_classes ) ) {
432 + if ( ! strpos( $this->html, 'frm_form_field ' ) ) {
554 433 $classes .= ' frm_form_field';
555 434 }
556 -
557 435 $classes .= ' ' . $extra_classes;
558 436 }
559 437
560 438 $classes .= $this->field_obj->get_container_class();
@@ -559,12 +437,9 @@
559 437
560 438 $classes .= $this->field_obj->get_container_class();
561 439
562 440 // Get additional classes
563 - $classes = apply_filters( 'frm_field_div_classes', $classes, $this->field_obj->get_field(), array( 'field_id' => $this->field_id ) );
564 -
565 - // Remove unexpected characters from class.
566 - return implode( ' ', array_map( 'FrmFormsHelper::sanitize_layout_class', explode( ' ', $classes ) ) );
441 + return apply_filters( 'frm_field_div_classes', $classes, $this->field_obj->get_field(), array( 'field_id' => $this->field_id ) );
567 442 }
568 443
569 444 /**
570 445 * This filters shortcodes in the field HTML
@@ -569,57 +444,11 @@
569 444 /**
570 445 * This filters shortcodes in the field HTML
571 446 *
572 447 * @since 3.0
573 - *
574 - * @return void
575 448 */
576 449 private function process_wp_shortcodes() {
577 450 if ( apply_filters( 'frm_do_html_shortcodes', true ) ) {
578 451 $this->html = do_shortcode( $this->html );
579 452 }
580 - }
581 -
582 - /**
583 - * Adds multiple input attributes.
584 - *
585 - * @since 6.4.1
586 - *
587 - * @return void
588 - */
589 - private function add_multiple_input_attributes() {
590 - $field_type = $this->field_obj->get_field_column( 'type' );
591 -
592 - // Check if the field type is one of the following.
593 - if ( ! in_array( $field_type, array( 'radio', 'checkbox', 'data', 'product', 'scale' ), true ) ) {
594 - return;
595 - }
596 -
597 - $field = (array) $this->field_obj->get_field();
598 - $attributes = array();
599 -
600 - // Check if the field type is 'data' or 'product'.
601 - if ( in_array( $field_type, array( 'data', 'product' ), true ) ) {
602 - $data_type = FrmField::get_option( $field, 'data_type' );
603 - $is_radio = 'radio' === $data_type;
604 - } else {
605 - $is_radio = 'radio' === $field_type || 'scale' === $field_type;
606 - }
607 -
608 - // Add 'role' attribute to the field.
609 - $attributes['role'] = $is_radio ? 'radiogroup' : 'group';
610 -
611 - // Add 'aria-required' attribute to the field if required.
612 - if ( $is_radio && '1' === $field['required'] ) {
613 - $attributes['aria-required'] = 'true';
614 - }
615 -
616 - // Add 'aria-invalid' attribute to the group if there are errors.
617 - if ( isset( $this->pass_args['errors'][ 'field' . $this->field_id ] ) ) {
618 - $attributes['aria-invalid'] = 'true';
619 - }
620 -
621 - // Concatenate attributes into a string, and replace the role="group" in the HTML with the attributes string.
622 - $html_attributes = FrmAppHelper::array_to_html_params( $attributes );
623 - $this->html = str_replace( ' role="group"', $html_attributes, $this->html );
624 453 }
625 454 }