Documentation · Developer Documentation

Repository Structure

This page gives a public-safe orientation to the plugin's repository. A full file and class inventory, namespace map and module-by-module description are maintained as internal documentation and are not published here.

Orientation

At the top level the repository contains the plugin's main PHP entry file, its admin and template assets, its bundled translations, a tests/ directory used by the project's own continuous integration, and the public documentation set you are currently reading under docs/.

For contributors who need a working development environment, see Local Development Setup. For coding conventions, see Coding Standards.

Supported public integration surfaces

When integrating with the plugin, prefer these stable surfaces:

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.