Home

MEET KIRKI: The WordPress Customizer Toolkit.

Kirki is not a framework. It's a Toolkit allowing WordPress developers to use the Customizer and take advantage of its advanced features and flexibility by abstracting the code and making it easier for everyone to create beautiful and meaningful user experiences.

You can use Kirki to add configurations, fields, sections and panels to the customizer. This does not replace the WordPress Customizer API, you can still use the default WordPress methods and we advise you to familiarize yourselves with it. An excellent handbook for the WordPress Customizer can be found on the developer.wordpress.org website.

Our API is simply a wrapper for the default WordPress methods, simplifying the syntax and allowing you to write more with less code and taking advantage of some of our most advanced features.

Usage:

First you will have to create a new configuration. Configurations have a unique ID and all fields that use the same config_id will inherit the properties of that configuration.

Once you add your configuration you can then add panels, sections and fields. Please note that you should have at least 1 section in your customizer in order to be able to add fields. Fields can't be 'orphan', they have to be grouped in a section.

Configuration:

Kirki::add_config()

See Configuration for more details.

Panels:

Kirki::add_panel()

See Panels for more details.

Sections:

Kirki::add_section()

See Sections for more details.

Fields:

Kirki::add_field()

See Fields for more details.