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.

Kirki::add_config($config_id,$args);

Example:

Arguments

capability: any valid WordPress capability. See the WordPress Codex for details.

option_type: can be either option or theme_mod. We recommend using theme_mod. If however you choose to use option you need to understand how your data will be saved, and in most cases you will also have to use the option_name argument as well.

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:

Licence

Kirki is licenced under the MIT Licence. It is 100% open-souce and you can use it on your projects.

Though not legally necessary, we would appreciate if you mention in your project's page that use Kirki and link to this project.

Support

Support is provided from the github repository. Though we do our best to reply to everyone in a timely manner and address any questions or issues you might have, keep in mind that Kirki is an open-source project maintained by people donating hundreds of hours.