Are you a theme author? Checkout new Kirki Helpers for your themes, or start something new using our _s fork as a starting point!

Configuration

Improve this page

When you create a project in Kirki, the first thing you have to do is create a configuration. Configurations allow each project to use a different setup and act as identifiers so it’s important you create one. Fields that belong to your configuration will inherit your config properties.

<?php Kirki::add_config( $config_id, $args ); ?>

Example:

<?php
Kirki::add_config( 'my_theme', array(
	'capability'    => 'edit_theme_options',
	'option_type'   => 'theme_mod',
) );
?>

Arguments

  • capability: any valid WordPress capability. See the WordPress Codex for details.
  • option_type: can be either option or theme_mod.
  • option_name: If you’re using options instead of theme mods then you can use this to specify an option name. All your fields will then be saved as an array under that option in the WordPress database.
  • disable_output: Set to true if you don’t want Kirki to automatically output any CSS for your config (defaults to false).

To create a field that will then use this configuration you can add your fields like this:

<?php Kirki::add_field( 'my_theme', $field_args ); ?>
The following docs are for Kirki 2.2.0 and above.