training.php
Kindly Edit > Training and each screen's video button, playing the public guide's current recordings.
Responsibility#
Kindly Edit > Training (0.9.21 and later, last in the Kindly Edit menu, for accounts that can edit pages) and the small video button on each Kindly Edit screen (Templates, Loops, Popups and Submissions beside the title, Theme at the end of its title row beside the publish status; Saved in its Global elements and Saved templates section headers). The videos play from the public guide's embed pages (/docs/embed/<video>/), so every site shows the current recording; nothing loads until someone opens Training or presses a video button. A white-labeled copy (an empty cantata_edit_docs_url) has no Training screen and no video buttons. Every player is sandboxed (scripts, same origin and new tabs only), sends no referrer and does not autoplay. See Training.
This is an implementation reference for the released 0.9.21 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_TRAINING_PAGE = 'kindly-training';
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 |
|---|---|
add_action |
admin_menu |
add_action |
admin_enqueue_scripts |
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_training_courses#
function cantata_edit_training_courses(): array
The two courses on the Training screen: [ video => title ].
Source location: includes/training.php:15.
cantata_edit_training_screens#
function cantata_edit_training_screens(): array
Each screen's video: [ screen => [ video, title ] ]. Video names are the guide's watch pages (docs/watch/
Source location: includes/training.php:23.
cantata_edit_training_url#
function cantata_edit_training_url( string $video, bool $embed = true ): string
A video's embed page and its watch page (transcript, chapters), or '' without a guide.
Implementation connections: cantata_edit_docs_url.
Source location: includes/training.php:36.
cantata_edit_training_button#
function cantata_edit_training_button( string $screen ): string
A screen's video button: a small video icon beside its title (or in a section's header) that opens the video in a window over the screen (assets/kindly-training.js: Esc and Close leave it, the video stops, focus goes back). The player's own bar has its chapters and the link to the transcript. Players are sandboxed (scripts and new tabs only) and send no referrer.
Implementation connections: cantata_edit_docs_url, cantata_edit_menu_parent, cantata_edit_training_screens, cantata_edit_training_url.
Source location: includes/training.php:47.
cantata_edit_training_page#
function cantata_edit_training_page(): void
Kindly Edit > Training: the two courses, each in its own section, playing from the guide.
Implementation connections: cantata_edit_asset_ver, cantata_edit_docs_url, cantata_edit_menu_head, cantata_edit_menu_section, cantata_edit_menu_site_look, cantata_edit_training_courses, cantata_edit_training_url.
Source location: includes/training.php:68.