aristath/kirki

View on GitHub
packages/kirki-framework/control-multicheck/src/Field/Multicheck.php

Summary

Maintainability
A
35 mins
Test Coverage
<?php
/**
 * Override field methods
 *
 * @package   kirki-framework/control-multicheck
 * @copyright Copyright (c) 2019, Ari Stathopoulos (@aristath)
 * @license   https://opensource.org/licenses/MIT
 * @since     1.0
 */

namespace Kirki\Field;

use Kirki\Field;

/**
 * Field overrides.
 *
 * @since 1.0
 */
class Multicheck extends Field {

    /**
     * The field type.
     *
     * @access public
     * @since 1.0
     * @var string
     */
    public $type = 'kirki-multicheck';

    /**
     * The control class-name.
     *
     * @access protected
     * @since 0.1
     * @var string
     */
    protected $control_class = '\Kirki\Control\Multicheck';

    /**
     * Whether we should register the control class for JS-templating or not.
     *
     * @access protected
     * @since 0.1
     * @var bool
     */
    protected $control_has_js_template = true;

    /**
     * Filter arguments before creating the setting.
     *
     * @access public
     * @since 0.1
     * @param array                $args         The field arguments.
     * @param WP_Customize_Manager $wp_customize The customizer instance.
     * @return array
     */
    public function filter_setting_args( $args, $wp_customize ) {
        if ( $args['settings'] === $this->args['settings'] ) {
            $args = parent::filter_setting_args( $args, $wp_customize );

            // Set the sanitize-callback if none is defined.
            if ( ! isset( $args['sanitize_callback'] ) || ! $args['sanitize_callback'] ) {
                $args['sanitize_callback'] = [ __CLASS__, 'sanitize' ];
            }
        }
        return $args;
    }

    /**
     * Filter arguments before creating the control.
     *
     * @access public
     * @since 0.1
     * @param array                $args         The field arguments.
     * @param WP_Customize_Manager $wp_customize The customizer instance.
     * @return array
     */
    public function filter_control_args( $args, $wp_customize ) {
        if ( $args['settings'] === $this->args['settings'] ) {
            $args         = parent::filter_control_args( $args, $wp_customize );
            $args['type'] = 'kirki-multicheck';
        }
        return $args;
    }

    /**
     * The sanitize method that will be used as a falback
     *
     * @static
     * @access public
     * @since 1.0
     * @param string|array $value The control's value.
     * @return array
     */
    public static function sanitize( $value ) {
        $value = ( ! is_array( $value ) ) ? explode( ',', $value ) : $value;
        return ( ! empty( $value ) ) ? array_map( 'sanitize_text_field', $value ) : [];
    }
}