Skip to content

API Reference

This section contains auto-generated API documentation for the Saltus Framework's public interfaces and classes.

Overview

The API reference is generated from PHPDoc annotations using phpDocumentor. It covers the public API surface — interfaces, classes, and methods tagged with @api.

Key Namespaces

NamespaceDescription
Saltus\WP\FrameworkCore entry point and modeler
Saltus\WP\Framework\ModelsModel interface, PostType, Taxonomy
Saltus\WP\Framework\RestREST controllers, route providers, policies
Saltus\WP\Framework\MCPMCP/Abilities infrastructure
Saltus\WP\Framework\MCP\ToolsMCP tool interfaces and implementations
Saltus\WP\Framework\Infrastructure\ContainerDI container interfaces
Saltus\WP\Framework\Infrastructure\PluginPlugin lifecycle interfaces
Saltus\WP\Framework\Infrastructure\ServiceService framework interfaces
Saltus\WP\Framework\FeaturesFeature service implementations

Generating the API Docs

bash
composer docs:api

This requires phpDocumentor to be installed. See the Build Guide for setup instructions.

GPL-3.0 License