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

transport

Improve this page

You can use the transport argument to define how your options will be applied to the preview.

There are 3 choices available: refresh, postMessage and auto.

refresh:

By default all fields use the refresh method. This will force-refresh the preview pane in the customizer when the value changes.

postMessage:

If you use the postMessage method, you can either write your own Javascript to change things in the preview area or use the js_vars argument.

If you decide to write your own scripts, we advise you to first read this post on developer.wordpress.org as well as this blog post on Otto’s blog.

auto:

If your field already contains an output argument you can set transport to auto. This will allow Kirki to auto-generate the js_vars argument according to your output and make the field work seamlessly both in the frontend and in the customizer without any code duplication.

The following docs are for Kirki 2.2.0 and above.