context-help.php
Builds bounded editor help context and forwards authorized help requests. Context describes the selected element and available controls rather than granting the help service unrestricted editing access.
Responsibility#
Builds bounded editor help context and forwards authorized help requests. Context describes the selected element and available controls rather than granting the help service unrestricted editing access.
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#
WordPress hooks#
| Operation | Hook |
|---|---|
add_action |
rest_api_init |
apply_filters |
cantata_edit_help_site_documentation |
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_context_help#
function cantata_edit_context_help( WP_REST_Request $req )
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_actions, cantata_edit_help_context, cantata_edit_help_site_context, cantata_edit_license.
Source location: includes/context-help.php:21.
cantata_edit_help_context#
function cantata_edit_help_context( $value, int $depth = 0 )
Bound structured diagnostic data; browser data is context, never authority.
Source location: includes/context-help.php:69.
cantata_edit_help_site_context#
function cantata_edit_help_site_context( int $post_id ): array
Only documented public design fields and the authorized page, never arbitrary options.
Implementation connections: cantata_edit_can_dev, cantata_edit_config, cantata_edit_help_context.
Source location: includes/context-help.php:85.
cantata_edit_help_actions#
function cantata_edit_help_actions( $list ): array
Proposed changes from Ask Kindly, kept to the four documented kinds; the editor checks them again and applies them as one Undo step that the person keeps, undoes or asks to redo.
Source location: includes/context-help.php:111.