<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* This file handles rendering the settings fields

[2] Fix | Delete

*

[3] Fix | Delete

* @since 2.0.0

[4] Fix | Delete

* @package Code_Snippets

[5] Fix | Delete

* @subpackage Settings

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

namespace Code_Snippets\Settings;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Represents a single setting field

[12] Fix | Delete

*

[13] Fix | Delete

* @property-read string $desc Field description.

[14] Fix | Delete

* @property-read string $label Field label.

[15] Fix | Delete

* @property-read string $type Field type.

[16] Fix | Delete

* @property-read string $name Setting name.

[17] Fix | Delete

*

[18] Fix | Delete

* @property-read int $min Minimum value (for numerical inputs).

[19] Fix | Delete

* @property-read int $max Maximum value(for numerical inputs).

[20] Fix | Delete

* @property-read array<string, string> $options List of options for a select or checkboxes field.

[21] Fix | Delete

* @property-read callable $render_callback Custom function to use when rendering a callback field.

[22] Fix | Delete

* @property-read callable $sanitize_callback Custom function to use when sanitize the setting value.

[23] Fix | Delete

* @property-read mixed $default Default setting value.

[24] Fix | Delete

*

[25] Fix | Delete

* @property-read string $input_name Value of `name` HTML attribute on an input element.

[26] Fix | Delete

* @property-read string $element_id

[27] Fix | Delete

*/

[28] Fix | Delete

class Setting_Field {

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Input field identifier.

[32] Fix | Delete

*

[33] Fix | Delete

* @var string

[34] Fix | Delete

*/

[35] Fix | Delete

private string $field_id;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Settings section identifier.

[39] Fix | Delete

*

[40] Fix | Delete

* @var string

[41] Fix | Delete

*/

[42] Fix | Delete

private string $section;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* List of possible arguments.

[46] Fix | Delete

*

[47] Fix | Delete

* @var array<string, mixed>

[48] Fix | Delete

*/

[49] Fix | Delete

private array $args = array(

[50] Fix | Delete

'desc' => '',

[51] Fix | Delete

'label' => '',

[52] Fix | Delete

'min' => null,

[53] Fix | Delete

'max' => null,

[54] Fix | Delete

'options' => [],

[55] Fix | Delete

);

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Class constructor.

[59] Fix | Delete

*

[60] Fix | Delete

* @param string $section_id Settings section identifier.

[61] Fix | Delete

* @param string $field_id Setting field identifier.

[62] Fix | Delete

* @param array<string, mixed> $args The setting field attributes.

[63] Fix | Delete

*/

[64] Fix | Delete

public function __construct( string $section_id, string $field_id, array $args ) {

[65] Fix | Delete

$this->field_id = $field_id;

[66] Fix | Delete

$this->section = $section_id;

[67] Fix | Delete

$this->args = array_merge( $this->args, $args );

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Retrieve a single setting attribute.

[72] Fix | Delete

*

[73] Fix | Delete

* @param string $argument Attribute name.

[74] Fix | Delete

*

[75] Fix | Delete

* @return mixed Attribute value.

[76] Fix | Delete

*/

[77] Fix | Delete

public function __get( string $argument ) {

[78] Fix | Delete

[79] Fix | Delete

if ( 'input_name' === $argument ) {

[80] Fix | Delete

return sprintf( '%s[%s][%s]', OPTION_NAME, $this->section, $this->field_id );

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

return $this->args[ $argument ];

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Retrieve the saved value for this setting.

[88] Fix | Delete

*

[89] Fix | Delete

* @return mixed

[90] Fix | Delete

*/

[91] Fix | Delete

private function get_saved_value() {

[92] Fix | Delete

return get_setting( $this->section, $this->field_id );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Render the setting field

[97] Fix | Delete

*/

[98] Fix | Delete

public function render() {

[99] Fix | Delete

$method_name = 'render_' . $this->type . '_field';

[100] Fix | Delete

[101] Fix | Delete

if ( method_exists( $this, $method_name ) ) {

[102] Fix | Delete

call_user_func( array( $this, $method_name ) );

[103] Fix | Delete

} else {

[104] Fix | Delete

// Error message, not necessary to translate.

[105] Fix | Delete

printf( 'Cannot render a %s field.', esc_html( $this->type ) );

[106] Fix | Delete

return;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

if ( $this->desc ) {

[110] Fix | Delete

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

[111] Fix | Delete

}

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* Render a callback field.

[116] Fix | Delete

*/

[117] Fix | Delete

public function render_callback_field() {

[118] Fix | Delete

if ( ! is_callable( $this->render_callback ) ) {

[119] Fix | Delete

return;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

call_user_func( $this->render_callback, $this->args );

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Render a single checkbox field.

[127] Fix | Delete

*

[128] Fix | Delete

* @param string $input_name Input name.

[129] Fix | Delete

* @param string $label Input label.

[130] Fix | Delete

* @param boolean $checked Whether the checkbox should be checked.

[131] Fix | Delete

*/

[132] Fix | Delete

private static function render_checkbox( string $input_name, string $label, bool $checked ) {

[133] Fix | Delete

[134] Fix | Delete

$checkbox = sprintf(

[135] Fix | Delete

'<input type="checkbox" name="%s"%s>',

[136] Fix | Delete

esc_attr( $input_name ),

[137] Fix | Delete

checked( $checked, true, false )

[138] Fix | Delete

);

[139] Fix | Delete

[140] Fix | Delete

$kses = [

[141] Fix | Delete

'input' => [

[142] Fix | Delete

'type' => [],

[143] Fix | Delete

'name' => [],

[144] Fix | Delete

'checked' => [],

[145] Fix | Delete

],

[146] Fix | Delete

];

[147] Fix | Delete

[148] Fix | Delete

if ( $label ) {

[149] Fix | Delete

printf(

[150] Fix | Delete

'<label>%s %s</label>',

[151] Fix | Delete

wp_kses( $checkbox, $kses ),

[152] Fix | Delete

wp_kses_post( $label )

[153] Fix | Delete

);

[154] Fix | Delete

} else {

[155] Fix | Delete

echo wp_kses( $checkbox, $kses );

[156] Fix | Delete

}

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Render a checkbox field for a setting

[161] Fix | Delete

*

[162] Fix | Delete

* @return void

[163] Fix | Delete

* @since 2.0.0

[164] Fix | Delete

*/

[165] Fix | Delete

public function render_checkbox_field() {

[166] Fix | Delete

$this->render_checkbox( $this->input_name, $this->label, $this->get_saved_value() ?? false );

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Render a checkbox field for a setting

[171] Fix | Delete

*

[172] Fix | Delete

* @return void

[173] Fix | Delete

* @since 2.0.0

[174] Fix | Delete

*/

[175] Fix | Delete

public function render_checkboxes_field() {

[176] Fix | Delete

$saved_value = $this->get_saved_value();

[177] Fix | Delete

$saved_value = is_array( $saved_value ) ? $saved_value : [];

[178] Fix | Delete

[179] Fix | Delete

echo '<fieldset>';

[180] Fix | Delete

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

[181] Fix | Delete

[182] Fix | Delete

foreach ( $this->options as $option => $label ) {

[183] Fix | Delete

$this->render_checkbox( $this->input_name . "[$option]", $label, in_array( $option, $saved_value, true ) );

[184] Fix | Delete

echo '<br>';

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

echo '</fieldset>';

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

/**

[191] Fix | Delete

* Render a basic text field for an editor setting.

[192] Fix | Delete

*

[193] Fix | Delete

* @return void

[194] Fix | Delete

*/

[195] Fix | Delete

private function render_text_field() {

[196] Fix | Delete

printf(

[197] Fix | Delete

'<input id="%s" type="text" name="%s" value="%s" class="regular-text %s">',

[198] Fix | Delete

esc_attr( $this->element_id ),

[199] Fix | Delete

esc_attr( $this->input_name ),

[200] Fix | Delete

esc_attr( $this->get_saved_value() ),

[201] Fix | Delete

esc_attr( $this->element_id )

[202] Fix | Delete

);

[203] Fix | Delete

[204] Fix | Delete

if ( $this->label ) {

[205] Fix | Delete

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

[206] Fix | Delete

}

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

/**

[210] Fix | Delete

* Render a number select field for an editor setting

[211] Fix | Delete

*

[212] Fix | Delete

* @since 2.0.0

[213] Fix | Delete

*/

[214] Fix | Delete

private function render_number_field() {

[215] Fix | Delete

printf(

[216] Fix | Delete

'<input type="number" name="%s" value="%s"',

[217] Fix | Delete

esc_attr( $this->input_name ),

[218] Fix | Delete

esc_attr( $this->get_saved_value() )

[219] Fix | Delete

);

[220] Fix | Delete

[221] Fix | Delete

if ( is_numeric( $this->min ) ) {

[222] Fix | Delete

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

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

if ( is_numeric( $this->max ) ) {

[226] Fix | Delete

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

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

echo '>';

[230] Fix | Delete

[231] Fix | Delete

if ( $this->label ) {

[232] Fix | Delete

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

[233] Fix | Delete

}

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

/**

[237] Fix | Delete

* Render a number select field for an editor setting.

[238] Fix | Delete

*

[239] Fix | Delete

* @since 3.0.0

[240] Fix | Delete

*/

[241] Fix | Delete

private function render_select_field() {

[242] Fix | Delete

$saved_value = $this->get_saved_value();

[243] Fix | Delete

printf( '<select name="%s">', esc_attr( $this->input_name ) );

[244] Fix | Delete

[245] Fix | Delete

foreach ( $this->options as $option => $option_label ) {

[246] Fix | Delete

printf(

[247] Fix | Delete

'<option value="%s"%s>%s</option>',

[248] Fix | Delete

esc_attr( $option ),

[249] Fix | Delete

selected( $option, $saved_value, false ),

[250] Fix | Delete

esc_html( $option_label )

[251] Fix | Delete

);

[252] Fix | Delete

}

[253] Fix | Delete

[254] Fix | Delete

echo '</select>';

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

/**

[258] Fix | Delete

* Render a button link.

[259] Fix | Delete

*

[260] Fix | Delete

* @since 3.5.1

[261] Fix | Delete

*/

[262] Fix | Delete

private function render_action_field() {

[263] Fix | Delete

printf(

[264] Fix | Delete

'<button type="submit" name="%s" class="button">%s</button>',

[265] Fix | Delete

esc_attr( $this->input_name ),

[266] Fix | Delete

esc_html( $this->label ? $this->label : $this->name )

[267] Fix | Delete

);

[268] Fix | Delete

}

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete