Full List of Magento 2 Events & How to Use Them

This article will provide you with a list of all events in Magento 2. As you know, Magento 2 is using the events-driven architecture which will help too much to extend the Magento functionality. We can understand this event as a kind of flag that rises when a specific situation happens. We will use an example module Mageplaza_HelloWorld to exercise this lesson.

What are Magento 2 Events?

Magento 2 events are designed to execute customized code when a specific Magento 2 event or custom event occurs. Modules dispatch events when specific actions are initiated. Upon dispatching an event, it has the capability to transmit data to any configured observers monitoring that particular event.

Dispatch event

In Magento 2 Events List, we can use the class Magento\Framework\Event\Manager to dispatch event. For example, we create a controller action in Mageplaza_HelloWorld to show the word “Hello World” on the screen:

File: app/code/Mageplaza/HelloWorld/Controller/Index/Test.php

<?php
namespace Mageplaza\HelloWorld\Controller\Index;

class Test extends \Magento\Framework\App\Action\Action
{

	public function execute()
	{
		echo "Hello World";
		exit;
	}
}

Now we want to dispatch a Magento 2 event list which allows another module to change the word displayed. We will change the controller like this:

File: app/code/Mageplaza/HelloWorld/Controller/Index/Test.php

<?php

namespace Mageplaza\HelloWorld\Controller\Index;

class Test extends \Magento\Framework\App\Action\Action
{

	public function execute()
	{
		$textDisplay = new \Magento\Framework\DataObject(array('text' => 'Mageplaza'));
		$this->_eventManager->dispatch('mageplaza_helloworld_display_text', ['mp_text' => $textDisplay]);
		echo $textDisplay->getText();
		exit;
	}
}

The dispatch method will receive 2 arguments: a unique event name and an array of data. In this example, we add the data object to the event and call it back to display the text.

Catch and handle event

Event area

Magento uses area definition to manage the store. We will have a frontend area and an admin area. With the configuration file, they can be put in 3 places:

• Under etc/ folder is the configuration that can be used in both admin and frontend.
• Under etc/frontend folder will be used for the frontend area.
• Under etc/adminhtml folder will be used for the admin area.

The same with the event configuration file. You can create event configuration file for each area like this:

• Admin area: app/code/Mageplaza/HelloWorld/etc/adminhtml/events.xml
• Frontend area: app/code/Mageplaza/HelloWorld/etc/frontend/events.xml
• Global area: app/code/Mageplaza/HelloWorld/etc/events.xml

Create events.xml

In this example, we only catch the event to show the word Mageplaza - Event on the frontend so we should create an events.xml file in etc/frontend folder.

File: app/code/Mageplaza/HelloWorld/etc/frontend/events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="mageplaza_helloworld_display_text">
        <observer name="mp_display_text" instance="Mageplaza\HelloWorld\Observer\ChangeDisplayText" />
    </event>
</config>

In this file, under config element, we define an event element with the name is the event name that was dispatched above. The class that will execute this event will be defined in the observer element by instance attribute. The name of observer is used to identify this with other observers of this event.

With this events.xml file, Magento will execute class Mageplaza\HelloWorld\Observer\ChangeDisplayText whenever the dispatch method of this event is called on frontend area. Please note that, we place events.xml in the frontend area, so if you dispatch that event in the admin area (like admin controller), it will not run.

Observer

Now we will create a class to execute above event.

Method 1

File: app/code/Mageplaza/HelloWorld/Observer/ChangeDisplayText.php

<?php

namespace Mageplaza\HelloWorld\Observer;

class ChangeDisplayText implements \Magento\Framework\Event\ObserverInterface
{
	public function execute(\Magento\Framework\Event\Observer $observer)
	{
		$displayText = $observer->getData('mp_text');
		echo $displayText->getText() . " - Event </br>";
		$displayText->setText('Execute event successfully.');

		return $this;
	}
}

This class will implement the ObserverInterface and declare the execute method. You can see this simple method to know how it works.

Let’s flush cache and see the result.

Method 2:

In Magento, there is another way to capture an event from an action controller. For example: <event name="sales_order_save_after">

<event name="sales_order_save_after">
   <observer name="mpcustomize_sales_order_save_after" instance="Mageplaza\Customize\Observer\OrderSaveAfter"/>
</event>

Here, you can see that the event sales_order_save_after is not initialized from any specific location, yet it can still be called and used.

The rule for calling and using such events must originate from an action controller. The example above is within the sales module’s save controller. The event name must also have either “after” or “before” appended to it.

Related post: How to Create Magento 2 Events & Observers

Magento 2 Events List

Events in PHP Files

JavaScript Varien Events

Summarize

Above is a comprehensive list of Magento Events compiled by Mageplaza along with instructional files. Please share your thoughts on the usefulness of this post in the Comments section below. Additionally, if you have any questions or concerns regarding events in Magento 2, feel free to ask us here, and we‘ll gladly assist you.

Related topics

• How to Create Module in Magento 2
• How to InstallSchema / InstallData in Magento 2

• How to Add Command line in Magento 2