Skip to content

Add docs for configurable event subscribers #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 27, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/customization/subscribing-to-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,29 @@ subscriptions.

:::

### Built-in event subscribers

Solidus comes with built-in event subscribers for some event-driven functionality in the system. For
example, all transactional emails are initiated through event subscribers.

When the `solidus_core` engine is loaded, all of the built-in event subscribers are loaded from
`Spree::Config.environment.subscribers`. If you wanted to exclude some of the built-in subscribers
you could do so from an initializer in your application:

```ruby
# config/initializers/spree.rb

Spree.config do |config|
config.environment.subscribers = [
"Spree::OrderCancelMailerSubscriber",
"Spree::OrderConfirmationMailerSubscriber",
"Spree::OrderInventoryCancellationMailerSubscriber"
]
end
```

See `Spree::AppConfiguration` for an up-to-date list of Solidus' built-in subscribers.

### Custom events

You're free to register your custom events into `Spree::Bus`. However, it's a good practice if you
Expand Down