Architecture and APIs
How the module is put together and the interfaces it exposes to your code. Pick the row for the question you have.
| I want to ... | Use | Needs |
|---|---|---|
| see how the field, the editor and the front-end script work together | Architecture | Nothing |
| know what each submodule provides | Submodules | Nothing |
| learn the class naming scheme and how it meets Bootstrap | CSS architecture | CSS |
| add utility classes, icon sets or alter the field render array | Hooks API reference | A custom module |
| call PHP services, JavaScript extension points or HTTP routes | API reference | A custom module |
| call the AI routes the editor uses for text, images and pages | AI API reference | AI set up on the site |
Which should I use
Start with the architecture page; the others assume its picture of the field, the editor and the front-end script. Use the hooks for small changes from a module, and the API reference when you integrate another system.
In this section
- Architecture: How the field, the editor and the front-end script work together
- Submodule architecture: The three submodules and what each one provides
- CSS architecture: The class naming scheme and how it combines with Bootstrap
- Hooks API: Alter hooks for utility classes, icon sets and the field render array
- API reference: PHP services, JavaScript extension points and HTTP routes
- AI API reference: The AI routes, their request fields and responses
Something wrong or missing on this page?
Report it
or edit the page.