Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 903 Bytes

File metadata and controls

21 lines (17 loc) · 903 Bytes
title intent tags prereqs complexity
Plugin Migration Guidelines
Checklist and patterns to migrate or update plugins for route and API changes
plugins
migration
compatibility
plugin-development.md
api-compatibility-and-deprecation.md
intermediate

Plugin Migration Guidelines

Checklist for plugin authors when core routes or APIs move:

  • Update plugin.json manifest if new entry points are required.
  • Avoid relying on hardcoded route paths; use SystemURLs::getRootPath() + configured endpoints.
  • If core provides shims, prefer calling official service methods rather than directly querying DB.

Compatibility:

  • Document breaking changes and provide examples for plugin updates.
  • Add tests that run plugin code against a staging instance with new routes.

Security:

  • Ensure plugin route middleware enforces the same auth checks as the core route it replaces.