Skip to content

Best practices

Jump to bottom Edit New page
Till edited this page Jun 4, 2025 · 2 revisions

This page is intended to list best practices when developing for this plugin. Feel free to add your own pitfalls as well!

Database

Foreign keys should always be named explicitly

  • Ease up changing them later.
  • If not explicitly named, MySQL / MariaDB will assign auto generated names, which end with _1, _2, etc. Sometimes these get inconsistent among installations, because of changes / repairing in the DB, rerunning failed migrations, etc. Explicitly naming foreign keys and adressing them by this name prevents all this.
Add a custom footer
Add a custom sidebar
Clone this wiki locally