Documentation · Developer Documentation
Logging And Debugging
This page describes how the plugin handles logging and debugging at a high level. The internal logger class, log-file location, rotation thresholds and masking rules are implementation details and are not published here.
High-level behaviour
- The plugin writes runtime diagnostics to its own log destination managed by WordPress, separate from the WordPress core debug log.
- Log volume is bounded: old entries are rotated and pruned automatically.
- Sensitive values (credentials, tokens, authorisation headers, signed-request headers) are masked before any line is written.
- When something goes wrong during an import or background job, the plugin surfaces an admin-side indication and writes a diagnostic entry that can be shared with support.
For administrators
If you need to share diagnostics with support, use the diagnostics-export function available from the plugin's admin UI rather than copying raw log files. The exported bundle contains the information support needs while keeping secrets masked.
For developers
Do not depend on specific log-file paths, formats or rotation behaviour from
external code; they are implementation details. When developing against the
plugin, prefer WordPress's standard WP_DEBUG workflow plus the plugin's
diagnostics export.
Supported public integration surfaces
When integrating with the plugin, prefer these stable surfaces:
- The plugin admin settings UI.
- The documented shortcodes.
- Theme-level template overrides as described in Template System And Overrides.
- The general Developer Overview for orientation.
Internal class names, option keys, database tables, REST and AJAX endpoints, cron hook names, capability and nonce identifiers, and release / update infrastructure are treated as implementation details. They may change between releases without notice and are not part of the public integration contract.
Stability and change policy
Anything not listed as a supported public surface above is considered an internal implementation detail. Internal APIs, storage layout and security implementation may change between releases. Do not depend on them from third-party code, themes or external systems. Direct database writes are not supported.
Public documentation notice. This page provides a high-level integration overview only. Internal implementation details, private APIs, storage internals and security-sensitive release infrastructure are maintained separately and are not part of the public documentation. Supported integration surfaces are the documented shortcodes, template overrides, settings UI and any extension points explicitly published in this section.