Overview


What to extend

There is no “Addon class” per-se. Generally speaking, you will create an “Addon aspect” which will have a corresponding parent class for you to extend.

For example, if you want to create a Tag, you’d extend our abstract Statamic\Extend\Tags class.

The abstract classes will provide your class with methods and properties that you can use to access contextual information, settings, data, and other helpful things.

Depending on the aspect you’re creating, you may gain additional helpers, however there are a number of them that all aspects will inherit. You may view a list of them over at the helper methods section.

Extensible Trait

For any non-addon classes in your addon (your own classes, that are not Tags, Modifiers, etc) you may use the Statamic\Extend\Extensible trait to get access to the helper methods. This trait is used by all the addon classes, which you get for free when extending one of the abstract classes.

Last modified on July 18, 2017