Checkbox.php
100 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Override field methods |
| 4 | * |
| 5 | * @package kirki-framework/checkbox |
| 6 | * @copyright Copyright (c) 2023, Themeum |
| 7 | * @license https://opensource.org/licenses/MIT |
| 8 | * @since 1.0 |
| 9 | */ |
| 10 | |
| 11 | namespace Kirki\Field; |
| 12 | |
| 13 | use Kirki\Field; |
| 14 | |
| 15 | /** |
| 16 | * Field overrides. |
| 17 | * |
| 18 | * @since 1.0 |
| 19 | */ |
| 20 | class Checkbox extends Field { |
| 21 | |
| 22 | /** |
| 23 | * The field type. |
| 24 | * |
| 25 | * @access public |
| 26 | * @since 1.0 |
| 27 | * @var string |
| 28 | */ |
| 29 | public $type = 'kirki-checkbox'; |
| 30 | |
| 31 | /** |
| 32 | * The control class-name. |
| 33 | * |
| 34 | * @access protected |
| 35 | * @since 0.1 |
| 36 | * @var string |
| 37 | */ |
| 38 | protected $control_class = '\Kirki\Control\Checkbox'; |
| 39 | |
| 40 | /** |
| 41 | * Whether we should register the control class for JS-templating or not. |
| 42 | * |
| 43 | * @access protected |
| 44 | * @since 0.1 |
| 45 | * @var bool |
| 46 | */ |
| 47 | protected $control_has_js_template = true; |
| 48 | |
| 49 | /** |
| 50 | * Filter arguments before creating the setting. |
| 51 | * |
| 52 | * @access public |
| 53 | * @since 0.1 |
| 54 | * @param array $args The field arguments. |
| 55 | * @param WP_Customize_Manager $wp_customize The customizer instance. |
| 56 | * @return array |
| 57 | */ |
| 58 | public function filter_setting_args( $args, $wp_customize ) { |
| 59 | |
| 60 | if ( $args['settings'] === $this->args['settings'] ) { |
| 61 | $args = parent::filter_setting_args( $args, $wp_customize ); |
| 62 | |
| 63 | // Set the sanitize-callback if none is defined. |
| 64 | if ( ! isset( $args['sanitize_callback'] ) || ! $args['sanitize_callback'] ) { |
| 65 | $args['sanitize_callback'] = function( $value ) { |
| 66 | return ( '0' === $value || 'false' === $value ) ? false : (bool) $value; |
| 67 | }; |
| 68 | } |
| 69 | |
| 70 | $args['default'] = isset( $args['default'] ) ? $args['default'] : false; |
| 71 | |
| 72 | // Make sure the default is formatted as boolean. |
| 73 | $args['default'] = (bool) ( 1 === $args['default'] || '1' === $args['default'] || true === $args['default'] || 'true' === $args['default'] || 'on' === $args['default'] ); |
| 74 | } |
| 75 | |
| 76 | return $args; |
| 77 | |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Filter arguments before creating the control. |
| 82 | * |
| 83 | * @access public |
| 84 | * @since 0.1 |
| 85 | * @param array $args The field arguments. |
| 86 | * @param WP_Customize_Manager $wp_customize The customizer instance. |
| 87 | * @return array |
| 88 | */ |
| 89 | public function filter_control_args( $args, $wp_customize ) { |
| 90 | |
| 91 | if ( $args['settings'] === $this->args['settings'] ) { |
| 92 | $args = parent::filter_control_args( $args, $wp_customize ); |
| 93 | $args['type'] = 'kirki-checkbox'; |
| 94 | } |
| 95 | |
| 96 | return $args; |
| 97 | |
| 98 | } |
| 99 | } |
| 100 |