shortcode

Nov 22, 2025

Changes in this version

+ var ErrDuplicateDefinition = errors.New("shortcode: duplicate definition")

+ var ErrInvalidDefinition = errors.New("shortcode: invalid definition")

+ var ErrMissingParameter = errors.New("shortcode: missing required parameter")

+ var ErrParameterType = errors.New("shortcode: parameter type mismatch")

+ var ErrUnknownParameter = errors.New("shortcode: unknown parameter")

+ func BuiltInDefinitions() []interfaces.ShortcodeDefinition

+ func NewNoOpService() interfaces.ShortcodeService

+ func NoOpMetrics() interfaces.ShortcodeMetrics

+ func RegisterBuiltIns(registry interfaces.ShortcodeRegistry, names []string) error

+ type DefinitionValidator interface

+ ValidateDefinition func(def interfaces.ShortcodeDefinition) error

+ type NoOpSanitizer struct

+ func (NoOpSanitizer) Sanitize(html string) (string, error)

+ func (NoOpSanitizer) ValidateAttributes(map[string]any) error

+ func (NoOpSanitizer) ValidateURL(string) error

+ type Registry struct

+ func NewRegistry(validator DefinitionValidator) *Registry

+ func (r *Registry) Get(name string) (interfaces.ShortcodeDefinition, bool)

+ func (r *Registry) List() []interfaces.ShortcodeDefinition

+ func (r *Registry) Register(def interfaces.ShortcodeDefinition) error

+ func (r *Registry) Remove(name string)

+ type Renderer struct

+ func NewRenderer(registry interfaces.ShortcodeRegistry, validator *Validator, ...) *Renderer

+ func (r *Renderer) Render(ctx interfaces.ShortcodeContext, shortcode string, params map[string]any, ...) (template.HTML, error)

+ func (r *Renderer) RenderAsync(ctx interfaces.ShortcodeContext, shortcode string, params map[string]any, ...) (<-chan template.HTML, <-chan error)

+ type RendererOption func(*Renderer)

+ func WithRendererCache(cache interfaces.CacheProvider) RendererOption

+ func WithRendererMetrics(metrics interfaces.ShortcodeMetrics) RendererOption

+ func WithRendererSanitizer(s interfaces.ShortcodeSanitizer) RendererOption

+ type Sanitizer struct

+ func NewSanitizer() *Sanitizer

+ func (s *Sanitizer) Sanitize(html string) (string, error)

+ func (s *Sanitizer) ValidateAttributes(attrs map[string]any) error

+ func (s *Sanitizer) ValidateURL(raw string) error

+ type Service struct

+ func NewService(registry interfaces.ShortcodeRegistry, renderer interfaces.ShortcodeRenderer, ...) *Service

+ func (s *Service) Process(ctx context.Context, content string, opts interfaces.ShortcodeProcessOptions) (string, error)

+ func (s *Service) Registry() interfaces.ShortcodeRegistry

+ func (s *Service) Render(ctx interfaces.ShortcodeContext, shortcode string, params map[string]any, ...) (template.HTML, error)

+ type ServiceOption func(*Service)

+ func WithDefaultCache(cache interfaces.CacheProvider) ServiceOption

+ func WithDefaultSanitizer(sanitizer interfaces.ShortcodeSanitizer) ServiceOption

+ func WithLogger(logger interfaces.Logger) ServiceOption

+ func WithMetrics(metrics interfaces.ShortcodeMetrics) ServiceOption

+ func WithParser(parser interfaces.ShortcodeParser) ServiceOption

+ func WithWordPressPreprocessor(pre *parserpkg.WordPressPreprocessor) ServiceOption

+ func WithWordPressSyntax(enabled bool) ServiceOption

+ type Validator struct

+ func NewValidator() *Validator

+ func (v *Validator) CoerceParams(def interfaces.ShortcodeDefinition, supplied map[string]any) (map[string]any, error)

+ func (v *Validator) ValidateDefinition(def interfaces.ShortcodeDefinition) error