help.php
Provides product help entry points and support context. It is separate from the context-aware Ask Kindly panel and from content-editing APIs.
Responsibility#
Provides product help entry points and support context. It is separate from the context-aware Ask Kindly panel and from content-editing APIs.
This is an implementation reference for the released 0.9.13 module. Internal PHP helpers are not a compatibility promise for third-party callers. Prefer the documented REST, Abilities, theme, and filter contracts.
Related modules#
Module constants#
const CANTATA_EDIT_HELP_SLUG = 'cantata-edit-help';
These values describe this release. Defined configuration constants and generated identifiers can have different ownership; do not edit stored values directly without following the corresponding workflow.
WordPress hooks#
| Operation | Hook |
|---|---|
apply_filters |
cantata_edit_docs_url |
add_action |
admin_menu |
add_action |
admin_head- |
add_action and add_filter subscribe to a hook; do_action and apply_filters expose a hook. A subscription is not itself a new extension API. Dynamic hook names are not included in this literal inventory.
Function and method reference#
cantata_edit_help_url#
function cantata_edit_help_url(): string
Where the guide is, for the editor's ⋯ menu ("How to edit this page").
Source location: includes/help.php:13.
cantata_edit_docs_url#
function cantata_edit_docs_url(): string
The public guide the editor's ? help buttons open, with a trailing slash: https://kindlyedit.com/docs/ by default, empty on a white-labeled installation. Filter cantata_edit_docs_url to point it at another HTTPS guide, or return an empty string to hide the buttons. The editor receives it as CantataEdit.docsUrl; assets/docs-links.js maps each tool to its page. Since 0.9.21 the same address also feeds Kindly Edit > Training and the screens' video buttons (training), and a query string or fragment on a filtered address is dropped, because page paths are added after it.
Source location: includes/help.php.
cantata_edit_help_content#
function cantata_edit_help_content(): string
The guide's body: what's inside
Implementation connections: cantata_edit_branding.
Source location: includes/help.php:32.
cantata_edit_help_page#
function cantata_edit_help_page(): void
Internal implementation helper in this module. Its name and signature identify the operation and accepted PHP values; it is not a standalone authenticated endpoint.
Implementation connections: cantata_edit_help_content, cantata_edit_intro_can_edit, cantata_edit_product_name.
Source location: includes/help.php:50.
cantata_edit_help_styles#
function cantata_edit_help_styles(): void
A readable column in wp-admin's own colors; the guide's page styles stay in the handout.
Source location: includes/help.php:67.