J5.x

How to Use Event Classes for Plugin Development

From Joomla! Documentation

Other languages:
English • ‎français
Joomla! 
≥ 5.2

Introduction[edit]

Joomla 5.2 introduces a new system for handling plugin events using event classes. This update brings a more structured and efficient way to manage events in the code, making plugin development and maintenance simpler and more robust.

This change improves the structure and ease of managing events in the code, making plugin development simpler and more robust. Plugins like action logs, editors, and authentication extensions have already been updated to use event classes.

How it Works[edit]

With this new system, event handling in Joomla plugins is now more organized through the use of event classes. Each event is encapsulated in its own class, making it easier to manage and extend. This results in cleaner, more maintainable code, and allows for better control over the behavior of plugins when certain actions are triggered.

For example, action log plugins now use specific event classes to handle logging events, making it easier for developers to customize or add new functionality based on specific actions.

How to Access[edit]

To start using event classes in your plugin development:

  1. Ensure your Joomla installation is updated to version 5.2.
  2. Review the updated plugin documentation to see how event classes are being used for plugins like action logs or authentication extensions.
  3. Adapt your own plugins by creating event classes that encapsulate specific actions or triggers, following the structure provided by Joomla 5.2.

By utilizing event classes, you can streamline your plugin development process and ensure that your code is more maintainable in the long term.

Additional Notes[edit]

This feature is part of Joomla’s ongoing effort to modernize the platform’s codebase, providing developers with more powerful tools to create flexible and reliable plugins. Event classes improve code structure and plugin management, particularly for action logs, editors, and authentication extensions.

Note on the Feature's Origin[edit]

This feature was added in Joomla 5.2 via the improvement introduced in #43639.