Settings reference
This page is rebuilt from the plugin schema on every npm run sync:settings-docs and docs build.
CoverKit Settings
Section titled “CoverKit Settings”- WordPress option:
coverkit_options - REST:
GET/POST /wp/v2/settings→coverkit_options - PHP:
coverkit_option( 'field_key' )(readscoverkit_options) - Schema source:
schemas/options.php
Plugin-wide options on Settings → CoverKit (or CoverKit → Settings when templates use the top-level menu).
| Key | Label | Type | Default | Constraints | Description |
|---|---|---|---|---|---|
image_format | Image Format | string | png | png, jpg, gif, webp | The format of the image. |
menu_in_media | Show under Media menu | boolean | false | — | When enabled, CoverKit templates appear under Media instead of a top-level CoverKit menu. Reload wp-admin after saving for the menu to update. |
CoverKit Presets
Section titled “CoverKit Presets”- WordPress option:
coverkit_presets - REST:
GET/POST /wp/v2/settings→coverkit_presets(array of objects) - Schema source:
schemas/templates.php
Dimension presets offered when creating a new template (label + width × height). Stored as a list; editable on the settings screen.
Each preset object uses these fields:
| Key | Label | Type | Default | Constraints | Description |
|---|---|---|---|---|---|
label | Label | string | New Template | — | The label of the image. |
width | Width | number | 1200 | min 1, max 10000 | The width of the image. |
height | Height | number | 630 | min 1, max 10000 | The height of the image. |
Default seeds on first activation come from schemas/default-presets.php.
Related storage (not on the settings screen)
Section titled “Related storage (not on the settings screen)”These options are managed elsewhere; listed so you do not confuse them with the fields above.
| Option | Purpose |
|---|---|
coverkit_version | Last plugin version migrations completed (includes/class-coverkit-updater.php). |
coverkit_generate_image | Internal queue for deferred image generation (includes/class-coverkit-rest.php). |
coverkit_usecases | Loader manifest for registered use cases (includes/class-coverkit-use-case-registry.php). |
_coverkit_use_cases | Per-template use case configuration (post meta on coverkit CPT). See Use cases. |
_coverkit_active_use_cases | Summary meta for active use cases on a template. |