Getting Started

How to add kirki to your project.

Configuring Project Add Panels and Sections Controls

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.

If you are building a WordPress theme that will be distributed (either free or premium), the first thing you have to decide when using Kirki is how your clients will get the plugin on your site.

Currently there are 2 options:

  1. Recommend (or require) the installation of Kirki as a plugin
  2. Embed Kirki in your theme.

Use a 3rd-party script to require/recommend the installation of Kirki

If you are using TGMPA or MerlinWP in your theme, then you can use those to recommend - or require - the installation of the Kirki plugin with your theme.

Use a custom script to recommend the installation of Kirki

If you don’t use one of the above scripts, then you can include this simple script in your theme to recommend the installation of Kirki from inside the customizer.

Usage:

Copy the file from here to your theme (for example in mytheme/inc/class-kirki-installer-section.php), and then in your functions.php file add this:

include_once get_theme_file_path( 'inc/class-kirki-installer-section.php' );
A word of caution for themes on wordpress.org:

If your theme will be distributed via wordpress.org you cannot require the installation of plugins but you can recommend them. That means that the theme will still have to work when kirki is not installed, for which we have already build a fallback PHP Class you can use in your themes here.

Embed in your theme

Though we do do not recommend embedding kirki in your theme it is still possible to do. You can simply copy the plugin in your theme and then include the main plugin file in your theme’s functions.php file.

Keep in mind that if you choose to follow this method Kirki will be “invisible” as a plugin to your clients and they will therefore be unable to update to future versions in case of bugfixes and/or security updates.

Edit this page