class-ld-settings-fields-checkbox.php 6.34 KB
<?php
/**
 * LearnDash Checkbox Settings Field.
 *
 * @since 3.0.0
 * @package LearnDash\Settings\Fields
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ( class_exists( 'LearnDash_Settings_Fields' ) ) && ( ! class_exists( 'LearnDash_Settings_Fields_Checkbox' ) ) ) {

	/**
	 * Class LearnDash Checkbox Settings Field.
	 *
	 * @since 3.0.0
	 * @uses LearnDash_Settings_Fields
	 */
	class LearnDash_Settings_Fields_Checkbox extends LearnDash_Settings_Fields {

		/**
		 * Public constructor for class
		 *
		 * @since 3.0.0
		 */
		public function __construct() {
			$this->field_type = 'checkbox';

			parent::__construct();
		}

		/**
		 * Function to crete the settings field.
		 *
		 * @since 3.0.0
		 *
		 * @param array $field_args An array of field arguments used to process the output.
		 * @return void
		 */
		public function create_section_field( $field_args = array() ) {

			/** This filter is documented in includes/settings/settings-fields/class-ld-settings-fields-checkbox-switch.php */
			$field_args = apply_filters( 'learndash_settings_field', $field_args );

			/** This filter is documented in includes/settings/settings-fields/class-ld-settings-fields-checkbox-switch.php */
			$html = apply_filters( 'learndash_settings_field_html_before', '', $field_args );

			if ( ( isset( $field_args['options'] ) ) && ( ! empty( $field_args['options'] ) ) ) {
				if ( ( isset( $field_args['desc'] ) ) && ( ! empty( $field_args['desc'] ) ) ) {
					$html .= $field_args['desc'];
				}

				if ( ! isset( $field_args['class'] ) ) {
					$field_args['class'] = '';
				}
				$field_args['class'] .= ' ld-checkbox-input';

				$html .= '<fieldset>';
				$html .= $this->get_field_legend( $field_args );

				$checkbox_multiple = '';
				if ( count( $field_args['options'] ) > 1 ) {
					$checkbox_multiple = '[]';
				}
				foreach ( $field_args['options'] as $option_key => $option_label ) {

					$html .= '<p class="learndash-section-field-checkbox-p">';
					$html .= '<input autocomplete="off" ';

					$html .= $this->get_field_attribute_type( $field_args );
					$html .= ' id="' . esc_attr( $this->get_field_attribute_id( $field_args, false ) ) . '-' . esc_attr( $option_key ) . '"';

					$html .= ' name="' . esc_attr( $this->get_field_attribute_name( $field_args, false ) ) . $checkbox_multiple . '"';
					$html .= $this->get_field_attribute_class( $field_args );
					$html .= $this->get_field_attribute_misc( $field_args );
					$html .= $this->get_field_attribute_required( $field_args );

					$html .= ' value="' . esc_attr( $option_key ) . '" ';

					if ( ( is_array( $field_args['value'] ) ) && ( in_array( $option_key, $field_args['value'], true ) ) ) {
						$html .= ' ' . checked( $option_key, $option_key, false ) . ' ';
					} elseif ( is_string( $field_args['value'] ) ) {
						$html .= ' ' . checked( $option_key, $field_args['value'], false ) . ' ';
					}

					$html .= ' />';

					$html .= '<label class="ld-checkbox-input__label" for="' . esc_attr( $field_args['id'] ) . '-' . esc_attr( $option_key ) . '" >';
					if ( is_string( $option_label ) ) {
						$html .= '<span>' . wp_kses_post( $option_label ) . '</span></label></p>';
					} elseif ( ( is_array( $option_label ) ) && ( ! empty( $option_label ) ) ) {
						if ( ( isset( $option_label['label'] ) ) && ( ! empty( $option_label['label'] ) ) ) {
							$html .= '<span>' . wp_kses_post( $option_label['label'] ) . '</span></label>';
						}
						$html .= '</p>';
						if ( ( isset( $option_label['description'] ) ) && ( ! empty( $option_label['description'] ) ) ) {
							$html .= '<p class="ld-checkbox-description">' . wp_kses_post( $option_label['description'] ) . '</p>';
						}
					} else {
						$html .= '</p>';
					}
				}

				$html .= '</fieldset>';

			}

			/** This filter is documented in includes/settings/settings-fields/class-ld-settings-fields-checkbox-switch.php */
			$html = apply_filters( 'learndash_settings_field_html_after', $html, $field_args );

			echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Need to output HTML
		}

		/**
		 * Validate field
		 *
		 * @since 3.0.0
		 *
		 * @param mixed  $val Value to validate.
		 * @param string $key Key of value being validated.
		 * @param array  $args Array of field args.
		 *
		 * @return integer value.
		 */
		public function validate_section_field( $val, $key, $args = array() ) {
			if ( ( isset( $args['field']['type'] ) ) && ( $this->field_type === $args['field']['type'] ) ) {
				if ( is_array( $val ) ) {
					foreach ( $val as $val_idx => $val_val ) {
						if ( ! isset( $args['field']['options'][ $val_val ] ) ) {
							unset( $val[ $val_val ] );
						}
					}
					return $val;
				} elseif ( is_string( $val ) ) {
					if ( ( '' === $val ) || ( isset( $args['field']['options'][ $val ] ) ) ) {
						return $val;
					} elseif ( isset( $args['field']['default'] ) ) {
						return $args['field']['default'];
					} else {
						return '';
					}
				}
			}

			return false;
		}

		/**
		 * Convert Settings Field value to REST value.
		 *
		 * @since 3.4.1
		 *
		 * @param mixed           $val        Value from REST to be converted to internal value.
		 * @param string          $key        Key field for value.
		 * @param array           $field_args Array of field args.
		 * @param WP_REST_Request $request    Request object.
		 */
		public function field_value_to_rest_value( $val, $key, $field_args, WP_REST_Request $request ) {
			if ( ( isset( $field_args['field']['type'] ) ) && ( $field_args['field']['type'] === $this->field_type ) ) {
				if ( in_array( $val, array( 'on', 'yes' ), true ) ) {
					$val = true;
				} else {
					$val = false;
				}
			}
			return $val;
		}

		/**
		 * Convert REST submit value to internal Settings Field acceptable value.
		 *
		 * @since 3.4.1
		 *
		 * @param mixed  $val         Value from REST to be converted to internal value.
		 * @param string $key         Key field for value.
		 * @param array  $field_args Array of field args.
		 */
		public function rest_value_to_field_value( $val = '', $key = '', $field_args = array() ) {
			if ( ( isset( $field_args['field']['type'] ) ) && ( $field_args['field']['type'] === $this->field_type ) ) {
				if ( true === $val ) {
					$val = 'on';
				} else {
					$val = '';
				}
			}
			return $val;
		}
	}
}
add_action(
	'learndash_settings_sections_fields_init',
	function() {
		LearnDash_Settings_Fields_Checkbox::add_field_instance( 'checkbox' );
	}
);