PHP Class Kirki_Customize_Control, kirki

Inheritance: extends WP_Customize_Control

Show file Open project: aristath/kirki Class Usage Examples

Public Properties

Property	Type	Description
$js_vars	array	Used to automatically generate all postMessage scripts.
$kirki_config	string	The kirki_config we're using for this control
$option_type	string	Data type
$output	array	Used to automatically generate all CSS output.
$tooltip	string	Tooltips content.

Protected Properties

Property	Type	Description
$l10n	array	The translation strings.

Public Methods

Method	Description
__construct ( WP_Customize_Manager $manager, string $id, array $args = [] )	Constructor.
to_json ( )	Refresh the parameters passed to the JavaScript via JSON.

Protected Methods

Method	Description
render ( )	Renders the control wrapper and calls $this->render_content() for the internals.
render_content ( )	Render the control's content.

Method Details

__construct() public method

Supplied $args override class property defaults. If $args['settings'] is not defined, use the $id as the setting ID.

Since: 2.3.5

public __construct ( WP_Customize_Manager $manager, string $id, array $args = [] )
$manager	WP_Customize_Manager	Customizer bootstrap instance.
$id	string	Control ID.
$args	array	{ Optional. Arguments to override class property defaults. @type int $instance_number Order in which this instance was created in relation to other instances. @type WP_Customize_Manager $manager Customizer bootstrap instance. @type string $id Control ID. @type array $settings All settings tied to the control. If undefined, `$id` will be used. @type string $setting The primary setting for the control (if there is one). Default 'default'. @type int $priority Order priority to load the control. Default 10. @type string $section Section the control belongs to. Default empty. @type string $label Label for the control. Default empty. @type string $description Description for the control. Default empty. @type array $choices List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values. Default empty array. @type array $input_attrs List of custom input attributes for control output, where attribute names are the keys and values are the values. Not used for 'checkbox', 'radio', 'select', 'textarea', or 'dropdown-pages' control types. Default empty array. @type array $json Deprecated. Use WP_Customize_Control::json() instead. @type string $type Control type. Core controls include 'text', 'checkbox', 'textarea', 'radio', 'select', and 'dropdown-pages'. Additional input types such as 'email', 'url', 'number', 'hidden', and 'date' are supported implicitly. Default 'text'. }

render() protected method

Renders the control wrapper and calls $this->render_content() for the internals.

protected render ( )

render_content() protected method

Render the control's content.

See also: WP_Customize_Control::render_content()

protected render_content ( )

to_json() public method

Refresh the parameters passed to the JavaScript via JSON.

See also: WP_Customize_Control::to_json()

public to_json ( )

Property Details

$js_vars public property

Used to automatically generate all postMessage scripts.

public array $js_vars
return	array

$kirki_config public property

The kirki_config we're using for this control

public string $kirki_config
return	string

$l10n protected property

The translation strings.