Project: Add option to limit field choices selection

classes/helpers/FrmFieldsHelper.php

@@ -474,6 +474,14 @@ public static function get_error_msg( $field, $error ) {
 			),
 		);
 
+		/**
+		 * @since x.x
+		 *
+		 * @param array        $defaults
+		 * @param array|object $field
+		 */
+		$defaults = apply_filters( 'frm_default_field_validation_messages', $defaults, $field );
+
 		$msg = FrmField::get_option( $field, $error );
 		$msg = $msg ? $msg : $defaults[ $error ]['part'];
 		$msg = do_shortcode( $msg );
@@ -2798,4 +2806,85 @@ private static function get_ai_generate_options_button_class() {
 			)
 		);
 	}
+
+	/**
+	 * Checks if the field choice should be hidden due to choice limit being reached.
+	 *
+	 * @since x.x
+	 *
+	 * @param string $choice_key
+	 * @param array  $field
+	 *
+	 * @return bool
+	 */
+	public static function should_hide_field_choice( $choice_key, $field ) {
+		/**
+		 * @since x.x
+		 *
+		 * @param bool   $hide_field_choice
+		 * @param string $choice_key
+		 * @param array  $field
+		 */
+		return (bool) apply_filters( 'frm_hide_field_choice', false, $choice_key, $field );
+	}
+
+	/**
+	 * @since x.x
+	 *
+	 * @param array $field
+	 *
+	 * @return bool
+	 */
+	public static function should_skip_rendering_options_for_field( $field ) {
+		/**
+		 * @since x.x
+		 *
+		 * @param bool  $skip_rendering_options_for_field
+		 * @param array $field
+		 */
+		return (bool) apply_filters( 'frm_should_skip_rendering_options_for_field', false, $field );
+	}
+
+	/**
+	 * Determine if 'disabled' attribute should be echoed in a field choice's HTML.
+	 *
+	 * @since x.x
+	 *
+	 * @param string $choice_key
+	 * @param bool   $is_selected_choice
+	 * @param array  $field
+	 *
+	 * @return bool
+	 */
+	public static function should_disable_option( $choice_key, $is_selected_choice, $field ) {
+		/**
+		 * @since x.x
+		 *
+		 * @param bool   $echo_disabled_attribute
+		 * @param string $choice_key
+		 * @param bool   $is_selected_choice
+		 * @param array  $field
+		 */
+		return (bool) apply_filters( 'frm_disable_option', false, $choice_key, $is_selected_choice, $field );
+	}
+
+	/**
+	 * @since x.x
+	 *
+	 * @param array  $field
+	 * @param string $choice_key
+	 *
+	 * @return void
+	 */
+	public static function after_option_input( $field, $choice_key ) {
+		/**
+		 * Allows adding content after checkbox, radio button, or dropdown fields.
+		 *
+		 * @since x.x
+		 *
+		 * @param array  $field The field data.
+		 * @param string $opt_key The option key.
+		 */
+		do_action( 'frm_after_option_input', $field, $choice_key );
+	}
 }

classes/views/frm-fields/back-end/field-options.php

@@ -5,6 +5,8 @@
 
 $field_option_count = is_array( $args['field']['options'] ) ? count( $args['field']['options'] ) : 0;
 ?>
+<span class="frm-hr frm-mb-sm"></span>
+
 <span class="frm-bulk-edit-link <?php echo $should_hide_bulk_edit ? 'frm_hidden' : ''; ?>">
 	<a href="#" title="<?php echo esc_attr( $option_title ); ?>" class="frm-h-stack frm-justify-end frm-bulk-edit-link">
 		<span>
@@ -24,8 +26,6 @@
 
 <?php do_action( 'frm_add_multiple_opts_labels', $args['field'] ); ?>
 
-<span class="frm-hr frm-mb-sm"></span>
-
 <ul id="frm_field_<?php echo esc_attr( $args['field']['id'] ); ?>_opts" class="frm_sortable_field_opts frm_clear<?php echo $field_option_count > 10 ? ' frm_field_opts_list' : ''; ?> frm_add_remove" data-key="<?php echo esc_attr( $args['field']['field_key'] ); ?>">
 	<?php $this->show_single_option( $args ); ?>
 </ul>

classes/views/frm-fields/back-end/settings.php

@@ -529,6 +529,14 @@
 					</p>
 					<?php
 				}
+
+				/**
+				 * @since x.x
+				 *
+				 * @param array $display
+				 * @param array $field
+				 */
+				do_action( 'frm_field_validation_messages', $display, $field );
 				?>
 			</div>
 		</div>

classes/views/frm-fields/front-end/checkbox-field.php

@@ -15,13 +15,21 @@
 	$type = $field['type'];
 	do_action( 'frm_after_checkbox', compact( 'field', 'field_name', 'type' ) );
 } elseif ( $field['options'] ) {
+	if ( FrmFieldsHelper::should_skip_rendering_options_for_field( $field ) ) {
+		return;
+	}
+
 	$option_index = 0;
 
 	foreach ( $field['options'] as $opt_key => $opt ) {
 		if ( isset( $shortcode_atts ) && isset( $shortcode_atts['opt'] ) && $shortcode_atts['opt'] !== $opt_key ) {
 			continue;
 		}
 
+		if ( FrmFieldsHelper::should_hide_field_choice( $opt_key, $field ) ) {
+			continue;
+		}
+
 		$field_val = FrmFieldsHelper::get_value_from_array( $opt, $opt_key, $field );
 		$opt       = FrmFieldsHelper::get_label_from_array( $opt, $opt_key, $field );
 
@@ -31,9 +39,9 @@
 		 * @since 5.0.04
 		 *
 		 * @param string $label Label HTML.
-		 * @param array  $args  The arguments. Contains `field`.
+		 * @param array  $args  The arguments. Contains `field` and `field_val`.
 		 */
-		$label = apply_filters( 'frm_choice_field_option_label', $opt, compact( 'field' ) );
+		$label = apply_filters( 'frm_choice_field_option_label', $opt, compact( 'field', 'field_val' ) );
 
 		// init.
 		$checked = '';
@@ -49,36 +57,45 @@
 		$other_opt  = false;
 		$other_args = FrmFieldsHelper::prepare_other_input( compact( 'field', 'field_name', 'opt_key', 'field_val' ), $other_opt, $checked );
 
+		$should_echo_disabled_att = FrmFieldsHelper::should_disable_option( $opt_key, $checked, $field );
 		?>
 		<div class="<?php echo esc_attr( apply_filters( 'frm_checkbox_class', 'frm_checkbox', $field, $field_val ) ); ?>" id="<?php echo esc_attr( FrmFieldsHelper::get_checkbox_id( $field, $opt_key ) ); ?>"><?php
 
-		if ( ! isset( $shortcode_atts ) || ! isset( $shortcode_atts['label'] ) || $shortcode_atts['label'] ) {
+		$include_label = ! isset( $shortcode_atts ) || ! isset( $shortcode_atts['label'] ) || $shortcode_atts['label'];
+
+		if ( $include_label ) {
 			$label_attributes = array(
 				'for' => $html_id . '-' . $opt_key,
 			);
 
-			if ( $read_only ) {
+			if ( $read_only || $should_echo_disabled_att ) {
 				$label_attributes['class'] = 'frm-label-disabled';
 			}
+
 			?>
 			<label <?php FrmAppHelper::array_to_html_params( $label_attributes, true ); ?>>
 			<?php
 		}
 
 		?><input type="checkbox" name="<?php echo esc_attr( $field_name ); ?>[<?php echo esc_attr( $other_opt ? $opt_key : '' ); ?>]" id="<?php echo esc_attr( $html_id ); ?>-<?php echo esc_attr( $opt_key ); ?>" value="<?php echo esc_attr( $field_val ); ?>"<?php
-		echo $checked . ' '; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 
 		do_action( 'frm_field_input_html', $field );
+		echo $checked . ' '; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+
+		if ( $should_echo_disabled_att ) {
+			echo 'disabled="disabled" data-max-reached="1" ';
+		}
 
 		if ( 0 === $option_index && FrmField::is_required( $field ) ) {
 			echo ' aria-required="true" ';
 		}
 
 		?> /><?php
 
-		if ( ! isset( $shortcode_atts ) || ! isset( $shortcode_atts['label'] ) || $shortcode_atts['label'] ) {
+		if ( $include_label ) {
 			echo ' ';
 			FrmAppHelper::kses_echo( $label, 'all' );
+			FrmFieldsHelper::after_option_input( $field, $opt_key );
 			echo '</label>';
 		}
 

classes/views/frm-fields/front-end/dropdown-field.php

@@ -19,6 +19,10 @@
 		)
 	);
 } else {
+	if ( FrmFieldsHelper::should_skip_rendering_options_for_field( $field ) ) {
+		return;
+	}
+
 	if ( $read_only ) {
 		?>
 		<select <?php do_action( 'frm_field_input_html', $field ); ?>>
@@ -46,6 +50,10 @@
 	}
 
 	foreach ( $field['options'] as $opt_key => $opt ) {
+		if ( FrmFieldsHelper::should_hide_field_choice( $opt_key, $field ) ) {
+			continue;
+		}
+
 		$field_val = FrmFieldsHelper::get_value_from_array( $opt, $opt_key, $field );
 		$opt       = FrmFieldsHelper::get_label_from_array( $opt, $opt_key, $field );
 		$selected  = FrmAppHelper::check_selected( $field['value'], $field_val );
@@ -72,7 +80,19 @@
 			$option_params['class'] = 'frm_other_trigger';
 		}
 
-		FrmHtmlHelper::echo_dropdown_option( $opt, (bool) $selected, $option_params );
+		if ( FrmFieldsHelper::should_disable_option( $opt_key, $selected, $field ) ) {
+			$option_params['disabled'] = 'disabled';
+		}
+
+		echo '<option ';
+		FrmAppHelper::array_to_html_params( $option_params, true );
+		selected( $selected );
+		echo '>';
+		echo esc_html( $opt === '' ? ' ' : $opt );
+		FrmFieldsHelper::after_option_input( $field, $opt_key );
+
+		echo '</option>';
+
 		unset( $option_params );
 	}//end foreach
 	?>

classes/views/frm-fields/front-end/radio-field.php

@@ -15,11 +15,20 @@
 	$type = $field['type'];
 	do_action( 'frm_after_checkbox', compact( 'field', 'field_name', 'type' ) );
 } elseif ( is_array( $field['options'] ) ) {
+	if ( FrmFieldsHelper::should_skip_rendering_options_for_field( $field ) ) {
+		return;
+	}
+	$include_label = ! isset( $shortcode_atts ) || ! isset( $shortcode_atts['label'] ) || $shortcode_atts['label'];
+
 	foreach ( $field['options'] as $opt_key => $opt ) {
 		if ( isset( $shortcode_atts ) && isset( $shortcode_atts['opt'] ) && $shortcode_atts['opt'] !== $opt_key ) {
 			continue;
 		}
 
+		if ( FrmFieldsHelper::should_hide_field_choice( $opt_key, $field ) ) {
+			continue;
+		}
+
 		$field_val = FrmFieldsHelper::get_value_from_array( $opt, $opt_key, $field );
 		$opt       = FrmFieldsHelper::get_label_from_array( $opt, $opt_key, $field );
 
@@ -29,18 +38,21 @@
 		 * @since 5.0.04
 		 *
 		 * @param string $label Label HTML.
-		 * @param array  $args  The arguments. Contains `field`.
+		 * @param array  $args  The arguments. Contains `field` and `field_val`.
 		 */
-		$label = apply_filters( 'frm_choice_field_option_label', $opt, compact( 'field' ) );
+		$label = apply_filters( 'frm_choice_field_option_label', $opt, compact( 'field', 'field_val' ) );
 		?>
 		<div class="<?php echo esc_attr( apply_filters( 'frm_radio_class', 'frm_radio', $field, $field_val ) ); ?>" id="<?php echo esc_attr( FrmFieldsHelper::get_checkbox_id( $field, $opt_key, 'radio' ) ); ?>"><?php
 
-		if ( ! isset( $shortcode_atts ) || ! isset( $shortcode_atts['label'] ) || $shortcode_atts['label'] ) {
+		$checked                  = FrmAppHelper::check_selected( $field['value'], $field_val ) ? 'checked="checked" ' : ' ';
+		$should_echo_disabled_att = FrmFieldsHelper::should_disable_option( $opt_key, trim( $checked ) !== '', $field );
+
+		if ( $include_label ) {
 			$label_attributes = array(
 				'for' => $html_id . '-' . $opt_key,
 			);
 
-			if ( $read_only ) {
+			if ( $read_only || $should_echo_disabled_att ) {
 				$label_attributes['class'] = 'frm-label-disabled';
 			}
 			?>
@@ -54,13 +66,18 @@
 		?>
 		<input type="radio" name="<?php echo esc_attr( $field_name ); ?>" id="<?php echo esc_attr( $html_id . '-' . $opt_key ); ?>" value="<?php echo esc_attr( $field_val ); ?>"
 		<?php
-		echo $checked . ' '; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 		do_action( 'frm_field_input_html', $field );
+		echo $checked; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+
+		if ( $should_echo_disabled_att ) {
+			echo 'disabled="disabled" ';
+		}
 		?>/><?php
 
-		if ( ! isset( $shortcode_atts ) || ! isset( $shortcode_atts['label'] ) || $shortcode_atts['label'] ) {
+		if ( $include_label ) {
 			echo ' ';
 			FrmAppHelper::kses_echo( $label, 'all' );
+			FrmFieldsHelper::after_option_input( $field, $opt_key );
 			echo '</label>';
 		}