Skip to content
CoverKit CoverKit v0.1.13

Settings reference

This page is rebuilt from the plugin schema on every npm run sync:settings-docs and docs build.

  • WordPress option: coverkit_options
  • REST: GET/POST /wp/v2/settingscoverkit_options
  • PHP: coverkit_option( 'field_key' ) (reads coverkit_options)
  • Schema source: schemas/options.php

Plugin-wide options on Settings → CoverKit (or CoverKit → Settings when templates use the top-level menu).

KeyLabelTypeDefaultConstraintsDescription
image_formatImage Formatstringpngpng, jpg, gif, webpThe format of the image.
menu_in_mediaShow under Media menubooleanfalseWhen enabled, CoverKit templates appear under Media instead of a top-level CoverKit menu. Reload wp-admin after saving for the menu to update.
  • WordPress option: coverkit_presets
  • REST: GET/POST /wp/v2/settingscoverkit_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:

KeyLabelTypeDefaultConstraintsDescription
labelLabelstringNew TemplateThe label of the image.
widthWidthnumber1200min 1, max 10000The width of the image.
heightHeightnumber630min 1, max 10000The height of the image.

Default seeds on first activation come from schemas/default-presets.php.

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.

OptionPurpose
coverkit_versionLast plugin version migrations completed (includes/class-coverkit-updater.php).
coverkit_generate_imageInternal queue for deferred image generation (includes/class-coverkit-rest.php).
coverkit_usecasesLoader manifest for registered use cases (includes/class-coverkit-use-case-registry.php).
_coverkit_use_casesPer-template use case configuration (post meta on coverkit CPT). See Use cases.
_coverkit_active_use_casesSummary meta for active use cases on a template.