aristath/kirki

View on GitHub
packages/kirki-framework/control-custom/src/Control/Custom.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/**
 * Customizer Control: custom.
 *
 * Creates a new custom control.
 * Custom controls accept raw HTML/JS.
 *
 * @package   kirki-framework/control-custom
 * @copyright Copyright (c) 2019, Ari Stathopoulos (@aristath)
 * @license   https://opensource.org/licenses/MIT
 * @since     1.0
 */

namespace Kirki\Control;

use Kirki\Control\Base;

/**
 * The "custom" control allows you to add any raw HTML.
 *
 * @since 1.0
 */
class Custom extends Base {

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

    /**
     * An Underscore (JS) template for this control's content (but not its container).
     *
     * Class variables for this control class are available in the `data` JS object;
     * export custom variables by overriding {@see WP_Customize_Control::to_json()}.
     *
     * @see WP_Customize_Control::print_template()
     *
     * @access protected
     * @since 1.0
     * @return void
     */
    protected function content_template() {
        ?>
        <label>
            <# if ( data.label ) { #><span class="customize-control-title">{{{ data.label }}}</span><# } #>
            <# if ( data.description ) { #><span class="description customize-control-description">{{{ data.description }}}</span><# } #>
            <?php
                /**
                 * The value is defined by the developer in the field configuration as 'default'.
                 * There is no user input on this field, it's a raw HTML/JS field and we do not sanitize it.
                 * Do not be alarmed, this is not a security issue.
                 * In order for someone to be able to change this they would have to have access to your filesystem.
                 * If that happens, they can change whatever they want anyways. This field is not a concern.
                 */
            ?>
            {{{ data.value }}}
        </label>
        <?php
    }
}