Aikeedo plugins

A plugin is a Composer package that Aikeedo loads at boot. It can add pages, API endpoints, settings screens, navigation items, scheduled work and integrations, and it can plug new implementations into the core’s extension points, without you editing a single core file.

This page applies to Aikeedo 5.x. Class names, paths and signatures match the 5.0 source code.

Anatomy of a plugin

extra/extensions/acme/hello/
├── composer.json          # package metadata; type: aikeedo-plugin
├── src/
│   └── Plugin.php         # entry class; implements PluginInterface
├── templates/             # Twig templates (any layout you like)
└── locale/                # translation catalogs

Two things make it a plugin:

composer.json declares "type": "aikeedo-plugin", requires heyaikeedo/composer, and names an entry class in extra.entry-class.
The entry class implements Plugin\Domain\PluginInterface:

src/Plugin.php

<?php

declare(strict_types=1);

namespace Acme\Hello;

use Override;
use Plugin\Domain\Context;
use Plugin\Domain\PluginInterface;
use Twig\Loader\FilesystemLoader;

class Plugin implements PluginInterface
{
    public function __construct(
        private FilesystemLoader $loader,
    ) {}

    #[Override]
    public function boot(Context $context): void
    {
        $this->loader->addPath(__DIR__ . '/../templates', 'acme-hello');
    }
}

The entry class is resolved from the dependency injection container, so anything you type-hint in the constructor is injected. That is how a plugin reaches the core: you ask for a registry, a collection or a mapper, and you register your own implementations inside boot().

Context is read-only metadata about your package, built from its composer.json. It has no container or event dispatcher on it. Use constructor injection instead.

How a plugin is loaded

Key points:

Plugins boot after every core module, so all core registries exist by the time boot() runs.
boot() runs on every request, including console and cron runs. Keep it cheap: register things, don’t do work.
Only plugins whose status is active boot. Themes are a special case: a theme is active when it’s the selected theme.
If a plugin crashes while booting, Aikeedo records the failure in var/plugin-health.json and skips the plugin on later requests, so one broken plugin can’t take the site down. With DEBUG on, the error is raised instead. See Debugging.

What plugins can extend

Capability	Where to start
Admin settings pages	Admin settings pages
Pages and JSON endpoints for signed-in users	App pages and APIs
Public pages, forms, endpoints and webhooks	Public pages and endpoints
Menu entries in the app and admin panel	Navigation
Reactions to domain events, and scheduled work	Events and cron
Payment gateways	Payment gateways
Tax engines	Tax engines
Storage backends	Storage adapters
Vector databases	Vector stores
AI providers and models	AI providers
Chat tools	AI tools
Currency exchange rates	Currency rate providers
Per-plan settings	Plan config extensions
Conversation import sources	Import adapters
Your own extension points, for other plugins to implement	Custom extension points

What plugins cannot do

Limitation	Why	What to do instead
Add Doctrine entities	Doctrine maps only the core `src/` directory	Store data in options, reuse core entities, or use your own external store. See Data and persistence
Add database migrations	Migration paths are fixed in `config/migrations.php`	Create any schema you need from an install hook against your own connection, or avoid extra tables
Add console commands	The command map in `config/commands.php` is static	Expose the action as an admin endpoint, or run it from cron
Replace core templates	Themes and plugins add namespaces, they don’t override core paths	Use `resources/views/overrides/`. See Extending Aikeedo

Where plugins live

Path	Contents
`extra/extensions/{vendor}/{name}`	The installed package, where Composer puts it
`extra/artifacts/`	Uploaded plugin archives, used as a Composer artifact repository
`public/e/{vendor}/{name}`	Public assets copied from `extra.public`. See Public assets
`var/plugin-backup/`	Backups taken before a reinstall
`var/plugin-health.json`	Recorded boot failures

Next steps

Build your first plugin

A working plugin with a settings page and a menu item, step by step.

Manifest reference

Every composer.json field Aikeedo reads.

Lifecycle and hooks

Install, activate, deactivate, uninstall and update.

Services you can inject

The core services a plugin reaches through its constructor.

Need Help?

If you need assistance with Aikeedo:

Professional Support

Get expert help from our team with a paid support subscription

Troubleshooting Guide

Check common issues and solutions

Get Started

Plugins

Extension Guides

Themes

Core Architecture

REST API

Anatomy of a plugin

How a plugin is loaded

What plugins can extend

What plugins cannot do

Where plugins live

Next steps

Build your first plugin

Manifest reference

Lifecycle and hooks

Services you can inject

Need Help?

Professional Support

Troubleshooting Guide

​Anatomy of a plugin

​How a plugin is loaded

​What plugins can extend

​What plugins cannot do

​Where plugins live

​Next steps

Build your first plugin

Manifest reference

Lifecycle and hooks

Services you can inject

​Need Help?

Professional Support

Troubleshooting Guide

Anatomy of a plugin

How a plugin is loaded

What plugins can extend

What plugins cannot do

Where plugins live

Next steps

Need Help?