22

✏️ Editing: Setting_Field.php

<?php

namespace Code_Snippets\Settings;

/**
 * Represents a single setting field.
 *
 * @property-read string                $desc               Field description.
 * @property-read string                $label              Field label.
 * @property-read string                $type               Field type.
 * @property-read string                $name               Setting name.
 *
 * @property-read int                   $min                Minimum value (for numerical inputs).
 * @property-read int                   $max                Maximum value(for numerical inputs).
 * @property-read array<string, string> $options            List of options for a select or checkboxes field.
 * @property-read callable              $render_callback    Custom function to use when rendering a callback field.
 * @property-read callable              $sanitize_callback  Custom function to use when sanitize the setting value.
 * @property-read mixed                 $default            Default setting value.
 *
 * @property-read string                $input_name         Value of `name` HTML attribute on an input element.
 * @property-read string                $element_id
 */
class Setting_Field {

/**
	 * Input field identifier.
	 *
	 * @var string
	 */
	private string $field_id;

/**
	 * Settings section identifier.
	 *
	 * @var string
	 */
	private string $section;

/**
	 * List of possible arguments.
	 *
	 * @var array<string, mixed>
	 */
	private array $args = array(
		'desc'    => '',
		'label'   => '',
		'min'     => null,
		'max'     => null,
		'options' => [],
	);

/**
	 * Class constructor.
	 *
	 * @param string               $section_id Settings section identifier.
	 * @param string               $field_id   Setting field identifier.
	 * @param array<string, mixed> $args       The setting field attributes.
	 */
	public function __construct( string $section_id, string $field_id, array $args ) {
		$this->field_id = $field_id;
		$this->section = $section_id;
		$this->args = array_merge( $this->args, $args );
	}

/**
	 * Retrieve a single setting attribute.
	 *
	 * @param string $argument Attribute name.
	 *
	 * @return mixed Attribute value.
	 */
	public function __get( string $argument ) {

if ( 'input_name' === $argument ) {
			return sprintf( '%s[%s][%s]', OPTION_NAME, $this->section, $this->field_id );
		}

return $this->args[ $argument ];
	}

/**
	 * Retrieve the saved value for this setting.
	 *
	 * @return mixed
	 */
	private function get_saved_value() {
		return get_setting( $this->section, $this->field_id );
	}

/**
	 * Render the setting field
	 */
	public function render() {
		switch ( $this->type ) {
			case 'callback':
				if ( is_callable( $this->render_callback ) ) {
					call_user_func( $this->render_callback, $this->args );
				}
				break;

case 'checkbox':
				$this->render_checkbox( $this->input_name, $this->label, $this->get_saved_value() ?? false );
				break;

case 'checkboxes':
				$this->render_checkboxes_field();
				break;

case 'text':
				$this->render_text_field();
				break;

case 'number':
				$this->render_number_field();
				break;

case 'select':
				$this->render_select_field();
				break;

case 'action':
				$this->render_action_field();
				break;

default:
				// Error message, not necessary to translate.
				printf( 'Cannot render a %s field.', esc_html( $this->type ) );
				return;

}

if ( $this->desc ) {
			echo '<p class="description">', wp_kses_post( $this->desc ), '</p>';
		}
	}

/**
	 * Render a single checkbox field.
	 *
	 * @param string $input_name Input name.
	 * @param string $label      Input label.
	 * @param bool   $checked    Whether the checkbox should be checked.
	 */
	private static function render_checkbox( string $input_name, string $label, bool $checked ) {
		$checkbox = sprintf(
			'<input type="checkbox" name="%s" %s>',
			esc_attr( $input_name ),
			checked( $checked, true, false )
		);

$allowed_html = [
			'input' => [
				'type'    => [],
				'name'    => [],
				'checked' => [],
			],
		];

if ( $label ) {
			printf(
				'<label>%s %s</label>',
				wp_kses( $checkbox, $allowed_html ),
				wp_kses_post( $label )
			);
		} else {
			echo wp_kses( $checkbox, $allowed_html );
		}
	}

/**
	 * Render a checkbox field for a setting
	 *
	 * @return void
	 * @since 2.0.0
	 */
	public function render_checkboxes_field() {
		$saved_value = $this->get_saved_value();
		$saved_value = is_array( $saved_value ) ? $saved_value : [];

echo '<fieldset>';
		printf( '<legend class="screen-reader-text"><span>%s</span></legend>', esc_html( $this->name ) );

foreach ( $this->options as $option => $label ) {
			$this->render_checkbox( $this->input_name . "[$option]", $label, in_array( $option, $saved_value, true ) );
			echo '<br>';
		}

echo '</fieldset>';
	}

/**
	 * Render a basic text field for an editor setting.
	 *
	 * @return void
	 */
	private function render_text_field() {
		printf(
			'<input id="%s" type="text" name="%s" value="%s" class="regular-text %s">',
			esc_attr( $this->element_id ),
			esc_attr( $this->input_name ),
			esc_attr( $this->get_saved_value() ),
			esc_attr( $this->element_id )
		);

if ( $this->label ) {
			echo ' ' . wp_kses_post( $this->label );
		}
	}

/**
	 * Render a number select field for an editor setting
	 *
	 * @since 2.0.0
	 */
	private function render_number_field() {
		printf(
			'<input type="number" name="%s" value="%s"',
			esc_attr( $this->input_name ),
			esc_attr( $this->get_saved_value() )
		);

if ( is_numeric( $this->min ) ) {
			printf( ' min="%d"', intval( $this->min ) );
		}

if ( is_numeric( $this->max ) ) {
			printf( ' max="%d"', intval( $this->max ) );
		}

echo '>';

if ( $this->label ) {
			echo ' ' . wp_kses_post( $this->label );
		}
	}

/**
	 * Render a number select field for an editor setting.
	 *
	 * @since 3.0.0
	 */
	private function render_select_field() {
		$saved_value = $this->get_saved_value();
		printf( '<select name="%s">', esc_attr( $this->input_name ) );

foreach ( $this->options as $option => $option_label ) {
			printf(
				'<option value="%s" %s>%s</option>',
				esc_attr( $option ),
				selected( $option, $saved_value, false ),
				esc_html( $option_label )
			);
		}

echo '</select>';
	}

/**
	 * Render a button link.
	 *
	 * @since 3.5.1
	 */
	private function render_action_field() {
		printf(
			'<button type="submit" name="%s" class="button">%s</button>',
			esc_attr( $this->input_name ),
			esc_html( $this->label ? $this->label : $this->name )
		);
	}
}

MR SKB