Kavro Documentation

Browse every Kavro module, field, context, and engineering guide from one responsive documentation hub.

Module Guides

Learn each Kavro framework area with examples and best practices.

Quick Start

In the main plugin file, or in wp-config.php during local testing:

Read guide →

Options Framework

The Options Framework creates a premium admin settings page and stores values in one WordPress option array.

Read guide →

Metabox Framework

The Metabox Framework adds Kavro fields to post, page, or custom post type edit screens.

Read guide →

Customizer Framework

Customizer panels/sections and live theme settings.

Read guide →

Taxonomy Options

Fields for category, tag, and custom taxonomy term screens.

Read guide →

Profile/User Options

Fields on WordPress user profile screens.

Read guide →

Nav Menu Options

Fields on nav menu item edit panels.

Read guide →

Widget Options

Kavro fields inside widget configuration forms.

Read guide →

Comment Options

Fields on comment edit screens.

Read guide →

Shortcode Framework

Register shortcodes and provide a generator UI.

Read guide →

Supported Fields

This page lists all public field type slugs. See each dedicated file for attributes and examples.

Read guide →

Shared Field Attributes

These attributes are available on most Kavro fields. Individual fields may support extra attributes, documented in their dedicated files.

Read guide →

Validation and Sanitization

Kavro sanitizes saved values by field type. Scalar fields use WordPress sanitizers such as sanitizetextfield(), sanitizeemail(), and escurlraw(). Complex fields are sanitized recursively.

Read guide →

Security

Kavro save actions should always use capability checks, nonces, and field-aware sanitization.

Read guide →

Performance

Kavro detects the active field profile and only loads heavy assets when needed.

Read guide →

Free vs Pro Architecture

Kavro supports module registration and gating for Free/Pro separation.

Read guide →

Popular Field Pages

Each field has a dedicated page with examples for all supported Kavro contexts.

Accordion

Field type: accordion Renderer class: Accordion Aliases using the same renderer: None

View field →

Ajax Select

Field type: ajaxselect Renderer class: AjaxSelect Aliases using the same renderer: None

View field →

Api Credentials

Field type: apicredentials Renderer class: ApiCredentials Aliases using the same renderer: None

View field →

Audio Upload

Field type: audioupload Renderer class: FileUpload Aliases using the same renderer: fileupload, videoupload

View field →

Background

Field type: background Renderer class: Background Aliases using the same renderer: None

View field →

Backup

Field type: backup Renderer class: Backup Aliases using the same renderer: None

View field →

Border

Field type: border Renderer class: Border Aliases using the same renderer: None

View field →

Border Radius

Field type: borderradius Renderer class: BorderRadius Aliases using the same renderer: None

View field →

Box Model

Field type: boxmodel Renderer class: BoxModel Aliases using the same renderer: None

View field →

Box Shadow

Field type: boxshadow Renderer class: BoxShadow Aliases using the same renderer: None

View field →

Business Hours

Field type: businesshours Renderer class: BusinessHours Aliases using the same renderer: None

View field →

Button

Field type: button Renderer class: Button Aliases using the same renderer: None

View field →

Button Set

Field type: buttonset Renderer class: ButtonSet Aliases using the same renderer: None

View field →

Cache Control

Field type: cachecontrol Renderer class: CacheControl Aliases using the same renderer: None

View field →

Capability Select

Field type: capabilityselect Renderer class: CapabilitySelect Aliases using the same renderer: None

View field →

Changelog

Field type: changelog Renderer class: Changelog Aliases using the same renderer: None

View field →

Checkbox

Field type: checkbox Renderer class: Checkbox Aliases using the same renderer: None

View field →

Checklist

Field type: checklist Renderer class: Checklist Aliases using the same renderer: None

View field →