Kindly EditDocumentationTry the editor

White-label identity

How approved branding changes product labels while preserving one compatible codebase.

Kindly Edit uses one codebase and one release stream for every installation. An approved license may carry a public identity; the plugin's internal slug, PHP functions, REST routes, option names and update service do not change. This avoids client-specific forks and lets every branded installation receive the same fixes.

What changes#

  • Product and provider names on the WordPress Plugins and Settings screens
  • Settings heading and optional logo
  • License, compatibility and update messages shown to administrators
  • Plugin details shown by WordPress during an update
  • Product identity made available to the on-page editor
  • The editor's ? help buttons, which open the Kindly Edit guide, are hidden. A site can show them again, pointed at its own guide, with the cantata_edit_docs_url filter (return an HTTPS address; the editor adds each page's path, such as design/typography/). Returning an empty string hides them on any installation.
  • Kindly Edit > Training and the video button on each Kindly Edit screen (0.9.21 and later) are left out too. If the cantata_edit_docs_url filter points at the brand's own guide, they come back and play from it, so that guide needs the same embed/<video>/ and watch/<video>/ pages. A query string or fragment on that address is dropped.

The source folder, REST namespace and update host remain cantata-edit. Those are implementation details and changing them per client would make updates and integrations brittle.

Approval and setup#

White-labeling is off by default. It cannot be enabled in WordPress. A Kindly Edit license administrator approves it on a particular license through the update service's authenticated admin API. Supported fields are:

Field Required Meaning
enabled Yes Must be true
product_name Yes The product name visible in WordPress
company_name No Provider shown on the Plugins screen
company_url No Provider link; HTTPS only
logo_url No Logo above Settings; HTTPS only
support_url No Reserved support destination; HTTPS only

The WordPress site receives the identity at activation and on its daily license check. Removing the branding from the license restores Kindly Edit's identity on the next successful check. Deactivating or invalidating a license also removes the stored white-label identity.

About this page

Documents Kindly Edit 0.9.16. Source: docs/WHITE-LABEL.md, includes/branding.php. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.