The "generic" control

Learn how to create controls using Kirki

Back to Controls

Returnsstring

The documentation site is currently being rewritten. If you can't find what you're looking for please check the github issues and ask for assistance there until the documentation rewrite is complete.

The generic control is one of the most versatile controls in Kirki. It allows you to create any HTML input type you want using any attributes you can imagine.

Example

Kirki::add_field( 'theme_config_id', array(
	'type'        => 'generic',
	'settings'    => 'generic_custom_setting',
	'label'       => esc_attr__( 'Custom input Control.', 'textdomain' ),
	'description' => esc_attr__( 'The "generic" control allows you to add any input type you want. In this case we use type="password" and define custom styles.', 'textdomain' ),
	'section'     => 'section_id',
	'default'     => '',
	'choices'     => array(
		'element'  => 'input',
		'type'     => 'password',
		'style'    => 'background-color:black;color:red;',
		'data-foo' => 'bar',
	),
) );

The above code will create this HTML in your control:

<input type="password" style="background-color:black;color:red;" data-foo="bar" />

The data-link is added automatically so your fields will work out of the box.

generic fields are an abstraction of text fields and textarea fields. These child controls internally use the generic control by passing on the appropriate arguments.

Edit this page