List of events

This is the list of event names ordered alphabetically. Each event contains a short description and a list of supported arguments.

abstract_search_result_load_after

Use cases

To modify product stock items and stock statuses.

Origins

\Magento\Framework\Data\AbstractSearchResult:

Copy
protected function afterLoad()
{
   $this->eventManager->dispatch('abstract_search_result_load_after', ['collection' => $this]);
Copied to your clipboard
protected function afterLoad()
{
   $this->eventManager->dispatch('abstract_search_result_load_after', ['collection' => $this]);

• collection is an object of \Magento\Framework\Data\AbstractSearchResult

Examples of classes that raise the event

• \Magento\CatalogInventory\Model\ResourceModel\Stock\Collection
• \Magento\CatalogInventory\Model\ResourceModel\Stock\Item\Collection
• \Magento\CatalogInventory\Model\ResourceModel\Stock\Status\Collection

abstract_search_result_load_before

Use cases

To modify product stock items and stock statuses.

Origins

\Magento\Framework\Data\AbstractSearchResult:

Copy
protected function beforeLoad()
{
$this->eventManager->dispatch('abstract_search_result_load_before', ['collection' => $this]);
Copied to your clipboard
protected function beforeLoad()
{
$this->eventManager->dispatch('abstract_search_result_load_before', ['collection' => $this]);

• collection is an object of \Magento\Framework\Data\AbstractSearchResult

Classes raising the event

• \Magento\CatalogInventory\Model\ResourceModel\Stock\Collection
• \Magento\CatalogInventory\Model\ResourceModel\Stock\Item\Collection
• \Magento\CatalogInventory\Model\ResourceModel\Stock\Status\Collection

adminhtml_block_eav_attribute_edit_form_init

Use cases

To modify backend attribute edit page form.

Origins

\Magento\Eav\Block\Adminhtml\Attribute\Edit\Main\AbstractMain:

Copy
protected function _initFormValue()
{
$this->eventManager->dispatch('adminhtml_block_eav_attribute_edit_form_init', ['form' => $this->getForm()]);
Copied to your clipboard
protected function _initFormValue()
{
$this->eventManager->dispatch('adminhtml_block_eav_attribute_edit_form_init', ['form' => $this->getForm()]);

• form is an object of \Magento\Framework\Data\Form

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Attribute\Edit\Tab\Main

adminhtml_block_html_before

Origins

• \Magento\Backend\Block\Template::_toHtml():

  Copy
  protected function _toHtml()
  {
  $this->_eventManager->dispatch('adminhtml_block_html_before', ['block' => $this]);
  Copied to your clipboard
  protected function _toHtml()
  {
  $this->_eventManager->dispatch('adminhtml_block_html_before', ['block' => $this]);

• \Magento\Customer\\Block\Adminhtml\Edit\Tab\Carts::_toHtml():

  Copy
  protected function _toHtml()
  {
  $this->_eventManager->dispatch('adminhtml_block_html_before', ['block' => $this]);
  Copied to your clipboard
  protected function _toHtml()
  {
  $this->_eventManager->dispatch('adminhtml_block_html_before', ['block' => $this]);

• block is an object of \Magento\Framework\View\Element\Template

Classes raising the event

• \Magento\AdminNotification\Block\System\Messages
• \Magento\AdobeIms\Block\Adminhtml\SignIn

Use cases

To modify backend block contents.

adminhtml_block_promo_widget_chooser_prepare_collection

Use cases

To modify collection of shopping cart rules used in a chooser widget.

Origins

\Magento\SalesRule\Block\Adminhtml\Promo\Widget\Chooser::_prepareCollection():

Copy
protected function _prepareCollection()
{
...
$this->_eventManager->dispatch(
         'adminhtml_block_promo_widget_chooser_prepare_collection',
         ['collection' => $collection]
);
Copied to your clipboard
protected function _prepareCollection()
{
...
$this->_eventManager->dispatch(
         'adminhtml_block_promo_widget_chooser_prepare_collection',
         ['collection' => $collection]
);

• collection is an object of \Magento\SalesRule\Model\ResourceModel\Rule\Collection

Classes raising the event

• \Magento\SalesRule\Block\Adminhtml\Promo\Widget\Chooser

adminhtml_block_salesrule_actions_prepareform

Use cases

To modify sales rule actions form.

Origins

\Magento\SalesRule\Block\Adminhtml\Promo\Quote\Edit\Tab\Actions::addTabToForm():

Copy
protected function addTabToForm($model
                              , $fieldsetId = 'actions_fieldset'
                              , $formName = 'sales_rule_form')
{
...
$this->_eventManager->dispatch('adminhtml_block_salesrule_actions_prepareform'
      , ['form' => $form]);
);
Copied to your clipboard
protected function addTabToForm($model
                              , $fieldsetId = 'actions_fieldset'
                              , $formName = 'sales_rule_form')
{
...
$this->_eventManager->dispatch('adminhtml_block_salesrule_actions_prepareform'
      , ['form' => $form]);
);

• form is an object of \Magento\Framework\Data\Form

Classes raising the event

• \Magento\SalesRule\Block\Adminhtml\Promo\Quote\Edit\Tab\Actions

adminhtml_cache_flush_all

Use cases

To perform actions before all cache is flushed.

Origins

• \Magento\Backend\Controller\Adminhtml\Cache\FlushAll::execute():

  Copy
  public function execute()
  {
  $this->_eventManager->dispatch('adminhtml_cache_flush_all');
  Copied to your clipboard
  public function execute()
  {
  $this->_eventManager->dispatch('adminhtml_cache_flush_all');

• \Magento\Backend\Console\Command\CacheFlushCommand::performAction():

  Copy
  protected function performAction(array $cacheTypes)
  {
  $this->eventManager->dispatch('adminhtml_cache_flush_all');
  Copied to your clipboard
  protected function performAction(array $cacheTypes)
  {
  $this->eventManager->dispatch('adminhtml_cache_flush_all');

Classes raising the event

• \Magento\Backend\Controller\Adminhtml\Cache\FlushAll
• \Magento\Backend\Console\Command\CacheFlushCommand

adminhtml_cache_flush_system

Use cases

To perform actions when system cache is cleaned.

Origins

• \Magento\Translation\Model\Inline\CacheManager::updateAndGetTranslations():

  Copy
  public function updateAndGetTranslations()
  {
  $this->eventManager->dispatch('adminhtml_cache_flush_system');
  Copied to your clipboard
  public function updateAndGetTranslations()
  {
  $this->eventManager->dispatch('adminhtml_cache_flush_system');

• \Magento\Backend\Controller\Adminhtml\Cache\FlushSystem::execute():

  Copy
  public function execute()
  {
  ...
  $this->_eventManager->dispatch('adminhtml_cache_flush_system');
  Copied to your clipboard
  public function execute()
  {
  ...
  $this->_eventManager->dispatch('adminhtml_cache_flush_system');

• \Magento\Backend\Console\Command\CacheCleanCommand::performAction()

  Copy
  protected function performAction(array $cacheTypes)
  {
  $this->eventManager->dispatch('adminhtml_cache_flush_system');
  Copied to your clipboard
  protected function performAction(array $cacheTypes)
  {
  $this->eventManager->dispatch('adminhtml_cache_flush_system');

Classes raising the the event

• \Magento\Translation\Model\Inline\CacheManager
• \Magento\Backend\Controller\Adminhtml\Cache\FlushSystem
• \Magento\Backend\Console\Command\CacheCleanCommand

adminhtml_cache_refresh_type

Use cases

• To perform actions before Full Page Cache is cleared.
• To perform actions after Configuration Cache is cleared.

Origins

• \Magento\Tax\Controller\Adminhtml\Tax\IgnoreTaxNotification::execute():

  Copy
  public function execute()
  {
  $this->_eventManager->dispatch('adminhtml_cache_refresh_type', ['type' => 'config']);
  Copied to your clipboard
  public function execute()
  {
  $this->_eventManager->dispatch('adminhtml_cache_refresh_type', ['type' => 'config']);

  • type for cache type cleared

• \Magento\PageCache\Model\Cache\Type::clean():

  Copy
  public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
  {
  $this->eventManager->dispatch('adminhtml_cache_refresh_type');
  Copied to your clipboard
  public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
  {
  $this->eventManager->dispatch('adminhtml_cache_refresh_type');

Classes raising the the event

• \Magento\Tax\Controller\Adminhtml\Tax\IgnoreTaxNotification
• \Magento\PageCache\Model\Cache\Type

adminhtml_catalog_category_tree_can_add_root_category

Use cases

To change availability of adding root category.

Origins

\Magento\Catalog\Block\Adminhtml\Category\Tree::canAddRootCategory():

Copy
public function canAddRootCategory()
{
  $options = new \Magento\Framework\DataObject(['is_allow' => true]);
  $this->_eventManager->dispatch(
      'adminhtml_catalog_category_tree_can_add_root_category',
      ['category' => $this->getCategory(), 'options' => $options, 'store' => $this->getStore()->getId()]
  );
Copied to your clipboard
public function canAddRootCategory()
{
  $options = new \Magento\Framework\DataObject(['is_allow' => true]);
  $this->_eventManager->dispatch(
      'adminhtml_catalog_category_tree_can_add_root_category',
      ['category' => $this->getCategory(), 'options' => $options, 'store' => $this->getStore()->getId()]
  );

• category - product category
• options - \Magento\Framework\DataObject(['is_allow' => true])
• store - current store ID

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Category\Checkboxes\Tree
• \Magento\Catalog\Block\Adminhtml\Category\Widget\Chooser

adminhtml_catalog_category_tree_can_add_sub_category

Use cases

To change availability of adding a subcategory.

Origins

\Magento\Catalog\Block\Adminhtml\Category\Tree::canAddSubCategory():

Copy
public function canAddSubCategory()
{
      $options = new \Magento\Framework\DataObject(['is_allow' => true]);
      $this->_eventManager->dispatch(
         'adminhtml_catalog_category_tree_can_add_sub_category',
         ['category' => $this->getCategory(), 'options' => $options, 'store' => $this->getStore()->getId()]
      );
Copied to your clipboard
public function canAddSubCategory()
{
      $options = new \Magento\Framework\DataObject(['is_allow' => true]);
      $this->_eventManager->dispatch(
         'adminhtml_catalog_category_tree_can_add_sub_category',
         ['category' => $this->getCategory(), 'options' => $options, 'store' => $this->getStore()->getId()]
      );

• category - product category
• options - \Magento\Framework\DataObject(['is_allow' => true])
• store - current store ID

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Category\Checkboxes\Tree
• \Magento\Catalog\Block\Adminhtml\Category\Widget\Chooser

adminhtml_catalog_category_tree_is_moveable

Use cases

To change moveability of a category.

Origins

\Magento\Catalog\Block\Adminhtml\Category\Tree::_isCategoryMoveable():

Copy
protected function _isCategoryMoveable($node)
{
      $options = new \Magento\Framework\DataObject(['is_moveable' => true, 'category' => $node]);

      $this->_eventManager->dispatch('adminhtml_catalog_category_tree_is_moveable', ['options' => $options]);
Copied to your clipboard
protected function _isCategoryMoveable($node)
{
      $options = new \Magento\Framework\DataObject(['is_moveable' => true, 'category' => $node]);

      $this->_eventManager->dispatch('adminhtml_catalog_category_tree_is_moveable', ['options' => $options]);

• options - \Magento\Framework\DataObject(['is_moveable' => true, 'category' => $node])

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Category\Checkboxes\Tree
• \Magento\Catalog\Block\Adminhtml\Category\Widget\Chooser

adminhtml_catalog_product_attribute_edit_frontend_prepare_form

Use cases

To customize a product attribute edit form.

Origins

\Magento\Catalog\Block\Adminhtml\Product\Attribute\Edit\Tab\Front::_prepareForm():

Copy
protected function _prepareForm()
{
...
$this->_eventManager->dispatch(
         'adminhtml_catalog_product_attribute_edit_frontend_prepare_form',
         ['form' => $form, 'attribute' => $attributeObject]
);
Copied to your clipboard
protected function _prepareForm()
{
...
$this->_eventManager->dispatch(
         'adminhtml_catalog_product_attribute_edit_frontend_prepare_form',
         ['form' => $form, 'attribute' => $attributeObject]
);

• form is an object of \Magento\Framework\Data\Form
• attribute is an object of \Magento\Catalog\Model\Entity\Attribute

Classes raising the event

\Magento\Catalog\Block\Adminhtml\Product\Attribute\Edit\Tab\Front

adminhtml_catalog_product_attribute_set_main_html_before

Use cases

To customize the adminhtml catalog attribute set main block.

Origins

\Magento\Catalog\Block\Adminhtml\Product\Attribute\Set\Main::_toHtml():

Copy
   protected function _toHtml()
   {
      $this->_eventManager->dispatch(
         'adminhtml_catalog_product_attribute_set_main_html_before',
         ['block' => $this]
      );
Copied to your clipboard
   protected function _toHtml()
   {
      $this->_eventManager->dispatch(
         'adminhtml_catalog_product_attribute_set_main_html_before',
         ['block' => $this]
      );

• block is an object of \Magento\Catalog\Block\Adminhtml\Product\Attribute\Set\Main

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Attribute\Set\Main

adminhtml_catalog_product_attribute_set_toolbar_main_html_before

Use cases

To customize the adminhtml catalog attribute set toolbar main block.

Origins

\Magento\Catalog\Block\Adminhtml\Product\Attribute\Set\Toolbar\Main::_toHtml():

Copy
   protected function _toHtml()
   {
      $this->_eventManager->dispatch(
         'adminhtml_catalog_product_attribute_set_toolbar_main_html_before',
         ['block' => $this]
      );
Copied to your clipboard
   protected function _toHtml()
   {
      $this->_eventManager->dispatch(
         'adminhtml_catalog_product_attribute_set_toolbar_main_html_before',
         ['block' => $this]
      );

• block is an object of \Magento\Catalog\Block\Adminhtml\Product\Attribute\Set\Toolbar\Main

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Attribute\Set\Toolbar\Main

adminhtml_catalog_product_edit_element_types

Use cases

To add or customize additional element types for catalog product edit attributes tab.

Origins

• \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes::_getAdditionalElementTypes():

  Copy
   protected function _getAdditionalElementTypes()
   {
   ...
   $this->_eventManager->dispatch('adminhtml_catalog_product_edit_element_types',
      ['response' => $response]);
  Copied to your clipboard
   protected function _getAdditionalElementTypes()
   {
   ...
   $this->_eventManager->dispatch('adminhtml_catalog_product_edit_element_types',
      ['response' => $response]);

• response is an object of \Magento\Framework\DataObject

Classes raising the event

• \Magento\Bundle\Block\Adminhtml\Catalog\Product\Edit\Tab\Attributes
• \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes

adminhtml_catalog_product_edit_prepare_form

Origins

• \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes::_prepareForm():

  Copy
   protected function _prepareForm()
   {
   ...
           $this->_eventManager->dispatch(
               'adminhtml_catalog_product_edit_prepare_form',
               ['form' => $form, 'layout' => $this->getLayout()]
           );
  Copied to your clipboard
   protected function _prepareForm()
   {
   ...
           $this->_eventManager->dispatch(
               'adminhtml_catalog_product_edit_prepare_form',
               ['form' => $form, 'layout' => $this->getLayout()]
           );

• \Magento\Catalog\Block\Adminhtml\Product\Attribute\NewAttribute\Product\Attributes::_prepareForm():

  Copy
   protected function _prepareForm()
   {
   ...
       $this->_eventManager->dispatch('adminhtml_catalog_product_edit_prepare_form',
           ['form' => $form]
       );
  Copied to your clipboard
   protected function _prepareForm()
   {
   ...
       $this->_eventManager->dispatch('adminhtml_catalog_product_edit_prepare_form',
           ['form' => $form]
       );

• form is an object of \Magento\Framework\Data\Form

• layout is an object of \Magento\Framework\View\LayoutInterface

There are only three classes that raise this event:

• \Magento\Bundle\Block\Adminhtml\Catalog\Product\Edit\Tab\Attributes
• \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes
• \Magento\Catalog\Block\Adminhtml\Product\Attribute\NewAttribute\Product\Attributes

Use cases

To customize catalog product edit attribute tab form

adminhtml_catalog_product_edit_tab_attributes_create_html_before

Origins

• \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes\Create::_toHtml():

  Copy
   protected function _toHtml()
   {
       $this->setCanShow(true);
       $this->_eventManager->dispatch(
           'adminhtml_catalog_product_edit_tab_attributes_create_html_before',
           ['block' => $this]
       );
  Copied to your clipboard
   protected function _toHtml()
   {
       $this->setCanShow(true);
       $this->_eventManager->dispatch(
           'adminhtml_catalog_product_edit_tab_attributes_create_html_before',
           ['block' => $this]
       );

• block is an object of \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes\Create

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Edit\Tab\Attributes\Create

Use cases

To customize catalog product edit create attribute block

adminhtml_catalog_product_form_prepare_excluded_field_list

Origins

• \Magento\Catalog\Block\Adminhtml\Product\Edit\Action\Attribute\Tab\Attributes::_prepareForm():

  Copy
   protected function _prepareForm(): void
   {
       $this->setFormExcludedFieldList($this->excludeFields);
       $this->_eventManager->dispatch(
           'adminhtml_catalog_product_form_prepare_excluded_field_list',
           ['object' => $this]
       );
  Copied to your clipboard
   protected function _prepareForm(): void
   {
       $this->setFormExcludedFieldList($this->excludeFields);
       $this->_eventManager->dispatch(
           'adminhtml_catalog_product_form_prepare_excluded_field_list',
           ['object' => $this]
       );

• object is an object of \Magento\Catalog\Block\Adminhtml\Product\Edit\Action\Attribute\Tab\Attributes

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Edit\Action\Attribute\Tab\Attributes

Use cases

To customize catalog product edit attribute tab block

adminhtml_catalog_product_grid_prepare_massaction

Use cases

To customize Mass Actions of a catalog product grid backend block.

Origins

• \Magento\Catalog\Block\Adminhtml\Product\Grid::_prepareMassaction():

  Copy
   protected function _prepareMassaction()
   {
    ...
  
    $this->_eventManager->dispatch('adminhtml_catalog_product_grid_prepare_massaction',
                                   ['block' => $this]);
    return $this;
   }
  Copied to your clipboard
   protected function _prepareMassaction()
   {
    ...
  
    $this->_eventManager->dispatch('adminhtml_catalog_product_grid_prepare_massaction',
                                   ['block' => $this]);
    return $this;
   }

• block is an object of \Magento\Catalog\Block\Adminhtml\Product\Grid

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Grid
• \Magento\UrlRewrite\Block\Catalog\Product\Grid

adminhtml_cmspage_on_delete

Origins

• \Magento\Cms\Controller\Adminhtml\Page\Delete::execute():

  Copy
   protected function execute()
   {
    ...
               $this->_eventManager->dispatch('adminhtml_cmspage_on_delete', [
                   'title' => $title,
                   'status' => 'success'
               ]);
  
               return $resultRedirect->setPath('*/*/');
           } catch (\Exception $e) {
               $this->_eventManager->dispatch(
                   'adminhtml_cmspage_on_delete',
                   ['title' => $title, 'status' => 'fail']
               );
    ...
   }
  Copied to your clipboard
   protected function execute()
   {
    ...
               $this->_eventManager->dispatch('adminhtml_cmspage_on_delete', [
                   'title' => $title,
                   'status' => 'success'
               ]);
  
               return $resultRedirect->setPath('*/*/');
           } catch (\Exception $e) {
               $this->_eventManager->dispatch(
                   'adminhtml_cmspage_on_delete',
                   ['title' => $title, 'status' => 'fail']
               );
    ...
   }

• title is a string, title of a cms page

• status is a string, 'success' or 'fail'

Classes raising the event

• \Magento\Cms\Controller\Adminhtml\Page\Delete

Use cases

To perform actions on either successful or unsuccessful cms page removal

adminhtml_controller_catalogrule_prepare_save

Origins

• \Magento\CatalogRule\Controller\Adminhtml\Promo\Catalog\Save::execute():

  Copy
   protected function execute()
   {
    ...
           try {
               $this->_eventManager->dispatch(
                   'adminhtml_controller_catalogrule_prepare_save',
                   ['request' => $this->getRequest()]
               );
    ...
   }
  Copied to your clipboard
   protected function execute()
   {
    ...
           try {
               $this->_eventManager->dispatch(
                   'adminhtml_controller_catalogrule_prepare_save',
                   ['request' => $this->getRequest()]
               );
    ...
   }

• request is a page request object of \Magento\Framework\App\RequestInterface

Classes raising the event

• \Magento\CatalogRule\Controller\Adminhtml\Promo\Catalog\Save

Use cases

To alter how a catalog price rule is being saved

adminhtml_controller_salesrule_prepare_save

Origins

• \Magento\SalesRule\Controller\Adminhtml\Promo\Quote\Save::execute():

  Copy
   protected function execute()
   {
    ...
           try {
               ...
               $this->_eventManager->dispatch(
                   'adminhtml_controller_salesrule_prepare_save',
                   ['request' => $this->getRequest()]
               );
    ...
   }
  Copied to your clipboard
   protected function execute()
   {
    ...
           try {
               ...
               $this->_eventManager->dispatch(
                   'adminhtml_controller_salesrule_prepare_save',
                   ['request' => $this->getRequest()]
               );
    ...
   }

• request is a page request object of \Magento\Framework\App\RequestInterface

Classes raising the event

• \Magento\SalesRule\Controller\Adminhtml\Promo\Quote\Save

Use cases

To alter how a cart price rule is being saved

adminhtml_customer_orders_add_action_renderer

Origins

• \Magento\Sales\Block\Adminhtml\Reorder\Renderer\Action::render():

  Copy
   public function render(\Magento\Framework\DataObject $row)
   {
       ...
       $this->_eventManager->dispatch(
           'adminhtml_customer_orders_add_action_renderer',
           ['renderer' => $this, 'row' => $row]
       );
  Copied to your clipboard
   public function render(\Magento\Framework\DataObject $row)
   {
       ...
       $this->_eventManager->dispatch(
           'adminhtml_customer_orders_add_action_renderer',
           ['renderer' => $this, 'row' => $row]
       );

• renderer is an object of \Magento\Sales\Block\Adminhtml\Reorder\Renderer\Action

• row is an object of \Magento\Framework\DataObject

Classes raising the event

• \Magento\Sales\Block\Adminhtml\Reorder\Renderer\Action

Use cases

To modify the way action sales admin reorder block is rendered

adminhtml_customer_prepare_save

Use cases

To modify a customer object before it is saved in admin panel.

Origins

\Magento\Customer\Controller\Adminhtml\Index\Save::execute():

Copy
   public function execute()
   {
   ...
               $this->_eventManager->dispatch(
                  'adminhtml_customer_prepare_save',
                  ['customer' => $customer, 'request' => $this->getRequest()]
               );
Copied to your clipboard
   public function execute()
   {
   ...
               $this->_eventManager->dispatch(
                  'adminhtml_customer_prepare_save',
                  ['customer' => $customer, 'request' => $this->getRequest()]
               );

• customer is an object of \Magento\Customer\Api\Data\CustomerInterface
• request is an object of \Magento\Framework\App\RequestInterface

Classes raising the event

• \Magento\Customer\Controller\Adminhtml\Index\Save

adminhtml_customer_save_after

Use cases

To modify a customer object after it is saved in admin panel.

Origins

\Magento\Customer\Controller\Adminhtml\Index\Save::execute():

Copy
   public function execute()
   {
   ...
               $this->_eventManager->dispatch(
                  'adminhtml_customer_save_after',
                  ['customer' => $customer, 'request' => $this->getRequest()]
               );
Copied to your clipboard
   public function execute()
   {
   ...
               $this->_eventManager->dispatch(
                  'adminhtml_customer_save_after',
                  ['customer' => $customer, 'request' => $this->getRequest()]
               );

• customer is an object of \Magento\Customer\Api\Data\CustomerInterface
• request is an object of \Magento\Framework\App\RequestInterface

Classes raising the event

• \Magento\Customer\Controller\Adminhtml\Index\Save

adminhtml_product_attribute_types

Use cases

To modify the way product attributes are processed.

Origins

• \Magento\Catalog\Block\Adminhtml\Product\Attribute\Edit\Tab\Main::execute():

  Copy
   private function processFrontendInputTypes(): void
   {
   ...
   $this->_eventManager->dispatch('adminhtml_product_attribute_types', ['response' => $response]);
  Copied to your clipboard
   private function processFrontendInputTypes(): void
   {
   ...
   $this->_eventManager->dispatch('adminhtml_product_attribute_types', ['response' => $response]);

• \Magento\Catalog\Model\Product\Attribute\Source\Inputtype::toOptionArray():

  Copy
  public function toOptionArray()
  {
  ...
  $this->_eventManager->dispatch('adminhtml_product_attribute_types', ['response' => $response]);
  Copied to your clipboard
  public function toOptionArray()
  {
  ...
  $this->_eventManager->dispatch('adminhtml_product_attribute_types', ['response' => $response]);

response is an object of \Magento\Framework\DataObject

Classes raising the event

• \Magento\Catalog\Block\Adminhtml\Product\Attribute\Edit\Tab\Main
• \Magento\Catalog\Model\Product\Attribute\Source\Inputtype

adminhtml_promo_quote_edit_tab_coupons_form_prepare_form

Use cases

To modify the admin coupon code form is generated.

Origins

\Magento\SalesRule\Block\Adminhtml\Promo\Quote\Edit\Tab\Coupons\Form::_prepareForm():

Copy
   protected function _prepareForm()
   {
      $this->_eventManager->dispatch(
         'adminhtml_promo_quote_edit_tab_coupons_form_prepare_form',
         ['form' => $form]
      );
Copied to your clipboard
   protected function _prepareForm()
   {
      $this->_eventManager->dispatch(
         'adminhtml_promo_quote_edit_tab_coupons_form_prepare_form',
         ['form' => $form]
      );

• form is an object of \Magento\Framework\Data\Form

Classes raising the event

• \Magento\SalesRule\Block\Adminhtml\Promo\Quote\Edit\Tab\Coupons\Form

adminhtml_sales_order_create_process_data

Use cases

To modify an order after it gets processed.

Origins

\Magento\Sales\Controller\Adminhtml\Order\Create::_processActionData():

Copy
   protected function _processActionData()
   {
   ...
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request' => $this->getRequest()->getPostValue(),
      ];

      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_data', $eventData);
Copied to your clipboard
   protected function _processActionData()
   {
   ...
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request' => $this->getRequest()->getPostValue(),
      ];

      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_data', $eventData);

• order_create_model is an object of \Magento\Sales\Model\AdminOrder\Create
• request is an array of POST values

Classes raising the event

• \Magento\Sales\Controller\Adminhtml\Order\Create\Cancel
• \Magento\Sales\Controller\Adminhtml\Order\Create\ProcessData

adminhtml_sales_order_create_process_data_before

Use cases

To modify an order before it gets processed.

Origins

\Magento\Sales\Controller\Adminhtml\Order\Create::_processActionData():

Copy
   protected function _processActionData()
   {
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request_model' => $this->getRequest(),
         'session' => $this->_getSession(),
      ];

      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_data_before', $eventData);
Copied to your clipboard
   protected function _processActionData()
   {
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request_model' => $this->getRequest(),
         'session' => $this->_getSession(),
      ];

      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_data_before', $eventData);

• order_create_model is an object of \Magento\Sales\Model\AdminOrder\Create
• request_model is an object of \Magento\Framework\App\RequestInterface
• session is an object of \Magento\Backend\Model\Session\Quote

Classes raising the event

• \Magento\Sales\Controller\Adminhtml\Order\Create\Cancel
• \Magento\Sales\Controller\Adminhtml\Order\Create\ProcessData

adminhtml_sales_order_create_process_item_after

Use cases

To modify an order item after it gets processed.

Origins

\Magento\Sales\Controller\Adminhtml\Order\Create::_processActionData():

Copy
   protected function _processActionData()
   {
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request_model' => $this->getRequest(),
         'session' => $this->_getSession(),
      ];
   ...
      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_item_after', $eventData);
Copied to your clipboard
   protected function _processActionData()
   {
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request_model' => $this->getRequest(),
         'session' => $this->_getSession(),
      ];
   ...
      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_item_after', $eventData);

• order_create_model is an object of \Magento\Sales\Model\AdminOrder\Create
• request_model is an object of \Magento\Framework\App\RequestInterface
• session is an object of \Magento\Backend\Model\Session\Quote

Classes raising the event

• \Magento\Sales\Controller\Adminhtml\Order\Create\Cancel
• \Magento\Sales\Controller\Adminhtml\Order\Create\ProcessData

adminhtml_sales_order_create_process_item_before

Use cases

To modify an order item before it gets processed.

Origins

\Magento\Sales\Controller\Adminhtml\Order\Create::_processActionData():

Copy
   protected function _processActionData()
   {
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request_model' => $this->getRequest(),
         'session' => $this->_getSession(),
      ];
   ...
      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_item_before', $eventData);
Copied to your clipboard
   protected function _processActionData()
   {
      $eventData = [
         'order_create_model' => $this->_getOrderCreateModel(),
         'request_model' => $this->getRequest(),
         'session' => $this->_getSession(),
      ];
   ...
      $this->_eventManager->dispatch('adminhtml_sales_order_create_process_item_before', $eventData);

• order_create_model is an object of \Magento\Sales\Model\AdminOrder\Create
• request_model is an object of \Magento\Framework\App\RequestInterface
• session is an object of \Magento\Backend\Model\Session\Quote

Classes raising the event

• \Magento\Sales\Controller\Adminhtml\Order\Create\Cancel
• \Magento\Sales\Controller\Adminhtml\Order\Create\ProcessData

adminhtml_sales_order_creditmemo_register_before

Use cases

To modify a credit memo before it gets saved in the registry.

Origins

• \Magento\Sales\Controller\Adminhtml\Order\CreditmemoLoader::load():

  Copy
   public function load()
   {
   ...
       $this->eventManager->dispatch(
           'adminhtml_sales_order_creditmemo_register_before',
           ['creditmemo' => $creditmemo, 'input' => $this->getCreditmemo()]
       );
  Copied to your clipboard
   public function load()
   {
   ...
       $this->eventManager->dispatch(
           'adminhtml_sales_order_creditmemo_register_before',
           ['creditmemo' => $creditmemo, 'input' => $this->getCreditmemo()]
       );

• creditmemo is an object of \Magento\Sales\Model\Order\Creditmemo

• input is a data array

Classes raising the event

• \Magento\Sales\Controller\Adminhtml\Order\CreditmemoLoader

adminhtml_store_edit_form_prepare_form

Use cases

To a store edit form before it gets rendered.

Origins

\Magento\Backend\Block\System\Store\Edit\AbstractForm::_prepareForm():

Copy
   protected function _prepareForm()
   {
   ...
      $this->_eventManager->dispatch('adminhtml_store_edit_form_prepare_form', ['block' => $this]);
Copied to your clipboard
   protected function _prepareForm()
   {
   ...
      $this->_eventManager->dispatch('adminhtml_store_edit_form_prepare_form', ['block' => $this]);

• block is an object of \Magento\Backend\Block\System\Store\Edit\AbstractForm

Classes raising the event

• \Magento\Backend\Block\System\Store\Edit\Form\Website
• \Magento\Backend\Block\System\Store\Edit\Form\Group
• \Magento\Backend\Block\System\Store\Edit\Form\Store

adminhtml_system_config_advanced_disableoutput_render_before

Use cases

To alter modules list before they get displayed.

Origins

\Magento\Config\Block\System\Config\Form\Fieldset\Modules\DisableOutput::render():

Copy
   protected function render()
   {
   ...
      $dispatchResult = new \Magento\Framework\DataObject($modules);
      $this->_eventManager->dispatch(
         'adminhtml_system_config_advanced_disableoutput_render_before',
         ['modules' => $dispatchResult]
      );
Copied to your clipboard
   protected function render()
   {
   ...
      $dispatchResult = new \Magento\Framework\DataObject($modules);
      $this->_eventManager->dispatch(
         'adminhtml_system_config_advanced_disableoutput_render_before',
         ['modules' => $dispatchResult]
      );

• modules is an object of \Magento\Framework\DataObject

Classes raising the event

• \Magento\Config\Block\System\Config\Form\Fieldset\Modules\DisableOutput

adminhtml_widget_grid_filter_collection

Use cases

To alter report collection or filter values.

Origins

\Magento\Reports\Block\Adminhtml\Grid::_prepareCollection():

Copy
   protected function _prepareCollection()
   {
   ...
         $this->_eventManager->dispatch(
               'adminhtml_widget_grid_filter_collection',
               ['collection' => $this->getCollection(), 'filter_values' => $this->_filterValues]
         );
Copied to your clipboard
   protected function _prepareCollection()
   {
   ...
         $this->_eventManager->dispatch(
               'adminhtml_widget_grid_filter_collection',
               ['collection' => $this->getCollection(), 'filter_values' => $this->_filterValues]
         );

• collection is an object of \Magento\Reports\Model\ResourceModel\Report\Collection
• filter_values is a value array

Classes raising the event

• \Magento\Reports\Block\Adminhtml\Grid

admin_permissions_role_prepare_save

Use cases

To alter the role object before it is saved.

Origins

\Magento\User\Controller\Adminhtml\User\Role\SaveRole::execute():

Copy
   public function execute()
   {
   ...
         $this->_eventManager->dispatch(
               'admin_permissions_role_prepare_save',
               ['object' => $role, 'request' => $this->getRequest()]
         );
Copied to your clipboard
   public function execute()
   {
   ...
         $this->_eventManager->dispatch(
               'admin_permissions_role_prepare_save',
               ['object' => $role, 'request' => $this->getRequest()]
         );

• object is an object of \Magento\Authorization\Model\Role
• request is an object of \Magento\Framework\App\RequestInterface

Classes raising the event

• \Magento\User\Controller\Adminhtml\User\Role\SaveRole

admin_system_config_changed_section_currency

Use cases

To perform actions after currency symbol is set in admin panel.

Origins

\Magento\CurrencySymbol\Model\System\Currencysymbol::setCurrencySymbolsData():

Copy
   public function setCurrencySymbolsData($symbols = [])
   {
   ...
      $this->_eventManager->dispatch(
         'admin_system_config_changed_section_currency',
         ['website' => $this->_websiteId, 'store' => $this->_storeId]
      );
Copied to your clipboard
   public function setCurrencySymbolsData($symbols = [])
   {
   ...
      $this->_eventManager->dispatch(
         'admin_system_config_changed_section_currency',
         ['website' => $this->_websiteId, 'store' => $this->_storeId]
      );

• website is a website ID
• store is a store ID

Classes raising the event

• \Magento\CurrencySymbol\Model\System\Currencysymbol

admin_system_config_changed_section_currency_before_reinit

Use cases

To perform actions before admin configuration reinitialized.

Origins

\Magento\CurrencySymbol\Model\System\Currencysymbol::setCurrencySymbolsData():

Copy
   public function setCurrencySymbolsData($symbols = [])
   {
   ...
      $this->_eventManager->dispatch(
         'admin_system_config_changed_section_currency_before_reinit',
         ['website' => $this->_websiteId, 'store' => $this->_storeId]
      );
Copied to your clipboard
   public function setCurrencySymbolsData($symbols = [])
   {
   ...
      $this->_eventManager->dispatch(
         'admin_system_config_changed_section_currency_before_reinit',
         ['website' => $this->_websiteId, 'store' => $this->_storeId]
      );

• website is a website ID
• store is a store ID

Classes raising the event

• \Magento\CurrencySymbol\Model\System\Currencysymbol

admin_system_config_changed_section_design

Use cases

To perform actions after admin design section saved or deleted.

Origins

• \Magento\Theme\Model\Design\Config\Plugin::afterSave():

  Copy
   public function afterSave(DesignConfigRepository $subject, DesignConfigInterface $designConfig)
   {
   ...
       $this->eventManager->dispatch(
           'admin_system_config_changed_section_design',
           ['website' => $website, 'store' => $store]
       );
  Copied to your clipboard
   public function afterSave(DesignConfigRepository $subject, DesignConfigInterface $designConfig)
   {
   ...
       $this->eventManager->dispatch(
           'admin_system_config_changed_section_design',
           ['website' => $website, 'store' => $store]
       );

• \Magento\Theme\Model\Design\Config\Plugin::afterDelete():

  Copy
   public function afterDelete(DesignConfigRepository $subject, DesignConfigInterface $designConfig)
   {
   ...
       $this->eventManager->dispatch(
           'admin_system_config_changed_section_design',
           ['website' => $website, 'store' => $store]
       );
  Copied to your clipboard
   public function afterDelete(DesignConfigRepository $subject, DesignConfigInterface $designConfig)
   {
   ...
       $this->eventManager->dispatch(
           'admin_system_config_changed_section_design',
           ['website' => $website, 'store' => $store]
       );

• website is an object of \Magento\Store\Api\Data\WebsiteInterface

• store is an object of \Magento\Store\Api\Data\StoreInterface

Classes raising the event

• \Magento\Theme\Model\Design\Config\Plugin

admin_system_config_save

Use cases

To perform actions after admin configuration is saved.

Origins

\Magento\Config\Controller\Adminhtml\System\Config\Save::execute():

Copy
   public function execute()
   {
   ...
         $this->_eventManager->dispatch(
               'admin_system_config_save',
               ['configData' => $configData, 'request' => $this->getRequest()]
         );
Copied to your clipboard
   public function execute()
   {
   ...
         $this->_eventManager->dispatch(
               'admin_system_config_save',
               ['configData' => $configData, 'request' => $this->getRequest()]
         );

• configData is a data array
• request is an object of \Magento\Framework\App\RequestInterface

Classes raising the event

• \Magento\Config\Controller\Adminhtml\System\Config\Save

admin_user_authenticate_after

Use cases

To perform actions after a user is authenticated.

Origins

• \Magento\User\Model\User::authenticate():

  Copy
   public function authenticate($username, $password)
   {
   ...
           $this->_eventManager->dispatch(
               'admin_user_authenticate_after',
               ['username' => $username, 'password' => $password, 'user' => $this, 'result' => $result]
           );
  Copied to your clipboard
  
   public function authenticate($username, $password)
   {
   ...
           $this->_eventManager->dispatch(
               'admin_user_authenticate_after',
               ['username' => $username, 'password' => $password, 'user' => $this, 'result' => $result]
           );

• \Magento\User\Model\User::performIdentityCheck():

  Copy
  public function performIdentityCheck($passwordString)
  {
  ...
       $this->_eventManager->dispatch(
           'admin_user_authenticate_after',
           [
               'username' => $this->getUserName(),
               'password' => $passwordString,
               'user' => $this,
               'result' => $isCheckSuccessful
           ]
       );
  Copied to your clipboard
  public function performIdentityCheck($passwordString)
  {
  ...
       $this->_eventManager->dispatch(
           'admin_user_authenticate_after',
           [
               'username' => $this->getUserName(),
               'password' => $passwordString,
               'user' => $this,
               'result' => $isCheckSuccessful
           ]
       );

• username is a username string

• password is a password string

• user is an object of \Magento\User\Model\User

• result is a boolean value

Classes raising the event

• \Magento\User\Model\User

admin_user_authenticate_before

Use cases

To perform actions before a user is authenticated.

Origins

\Magento\User\Model\User::authenticate():

Copy
   public function authenticate($username, $password)
   {
   ...
         $this->_eventManager->dispatch(
               'admin_user_authenticate_before',
               ['username' => $username, 'user' => $this]
         );
Copied to your clipboard
   public function authenticate($username, $password)
   {
   ...
         $this->_eventManager->dispatch(
               'admin_user_authenticate_before',
               ['username' => $username, 'user' => $this]
         );

• username is a username string
• user is an object of \Magento\User\Model\User

Classes raising the event

• \Magento\User\Model\User

amazon_customer_authenticated

Use cases

To perform actions before an Amazon user is authenticated.

Origins

\Amazon\Login\Helper\Session::dispatchAuthenticationEvent():

Copy
   protected function dispatchAuthenticationEvent()
   {
      $this->eventManager->dispatch('amazon_customer_authenticated');
   }
Copied to your clipboard
   protected function dispatchAuthenticationEvent()
   {
      $this->eventManager->dispatch('amazon_customer_authenticated');
   }

Used in functions:

Copy
   public function loginById($customerId)
   {
      $this->dispatchAuthenticationEvent();
   ...

   public function login(CustomerInterface $customerData)
   {
      $this->dispatchAuthenticationEvent();
   ...
Copied to your clipboard
   public function loginById($customerId)
   {
      $this->dispatchAuthenticationEvent();
   ...

   public function login(CustomerInterface $customerData)
   {
      $this->dispatchAuthenticationEvent();
   ...

Classes raising the event

• \Amazon\Login\Helper\Session

amazon_login_authorize_error

Use cases

To handle an Amazon login exception.

Origins

\Amazon\Login\Controller\Login\Authorize::execute():

Copy
   public function execute()
   {
   ..
      $this->_eventManager->dispatch('amazon_login_authorize_error', ['exception' => $e]);
   }
Copied to your clipboard
   public function execute()
   {
   ..
      $this->_eventManager->dispatch('amazon_login_authorize_error', ['exception' => $e]);
   }

• exception is an object of Magento\Framework\Exception\ValidatorException or \Exception

Classes raising the event

• \Amazon\Login\Controller\Login\Authorize

amazon_login_authorize_validation_error

Use cases

To handle a ValidatorException Amazon login exception.

Origins

\Amazon\Login\Controller\Login\Authorize::execute():

Copy
   public function execute()
   {
   ..
      $this->_eventManager->dispatch('amazon_login_authorize_validation_error', ['exception' => $e]);
   }
Copied to your clipboard
   public function execute()
   {
   ..
      $this->_eventManager->dispatch('amazon_login_authorize_validation_error', ['exception' => $e]);
   }

• exception is an object of Magento\Framework\Exception\ValidatorException

Classes raising the event

• \Amazon\Login\Controller\Login\Authorize

amazon_payment_authorize_before

Use cases

To perform actions before Amazon authorizes a payment.

Origins

\Amazon\Payment\Gateway\Request\AuthorizationRequestBuilder::build():

Copy
   public function build(array $buildSubject)
   {
   ..
         $transport = new DataObject($data);
         $this->eventManager->dispatch(
               'amazon_payment_authorize_before',
               [
                  'context' => 'authorization',
                  'payment' => $paymentDO->getPayment(),
                  'transport' => $transport
               ]
         );
   }
Copied to your clipboard
   public function build(array $buildSubject)
   {
   ..
         $transport = new DataObject($data);
         $this->eventManager->dispatch(
               'amazon_payment_authorize_before',
               [
                  'context' => 'authorization',
                  'payment' => $paymentDO->getPayment(),
                  'transport' => $transport
               ]
         );
   }

• context is a string authorization
• payment is an object of Magento\Payment\Model\InfoInterface
• transport is a DataObject object

Classes raising the event

• \Amazon\Payment\Gateway\Request\AuthorizationRequestBuilder

amazon_payment_pending_authorization_hard_decline_after

Use cases

To perform actions before a hard decline of Amazon payment.

Origins

\Amazon\Payment\Model\PaymentManagement\Authorization::hardDeclinePendingAuthorization():

Copy
   protected function hardDeclinePendingAuthorization(...)
   {
   ..
      $this->eventManager->dispatch(
         'amazon_payment_pending_authorization_hard_decline_after',
         [
               'order' => $order,
               'pendingAuthorization' => $pendingAuthorization,
         ]
      );
   }
Copied to your clipboard
   protected function hardDeclinePendingAuthorization(...)
   {
   ..
      $this->eventManager->dispatch(
         'amazon_payment_pending_authorization_hard_decline_after',
         [
               'order' => $order,
               'pendingAuthorization' => $pendingAuthorization,
         ]
      );
   }

• order is an object of \Magento\Sales\Api\Data\OrderInterface
• pendingAuthorization is an object of \Amazon\Payment\Api\Data\PendingAuthorizationInterface

Classes raising the event

• \Amazon\Payment\Model\PaymentManagement\Authorization

amazon_payment_pending_authorization_soft_decline_after

Use cases

To perform actions before a soft Amazon payment decline.

Origins

\Amazon\Payment\Model\PaymentManagement\Authorization::softDeclinePendingAuthorization():

Copy
   protected function softDeclinePendingAuthorization(...)
   {
   ..
      $this->eventManager->dispatch(
         'amazon_payment_pending_authorization_soft_decline_after',
         [
               'order' => $order,
               'pendingAuthorization' => $pendingAuthorization,
         ]
      );
   }
Copied to your clipboard
   protected function softDeclinePendingAuthorization(...)
   {
   ..
      $this->eventManager->dispatch(
         'amazon_payment_pending_authorization_soft_decline_after',
         [
               'order' => $order,
               'pendingAuthorization' => $pendingAuthorization,
         ]
      );
   }

• order is an object of \Magento\Sales\Api\Data\OrderInterface
• pendingAuthorization is an object of \Amazon\Payment\Api\Data\PendingAuthorizationInterface

Classes raising the event

• \Amazon\Payment\Model\PaymentManagement\Authorization

assigned_theme_changed

Use cases

To perform actions after an assigned theme changed.

Origins

\Magento\Theme\Observer\CheckThemeIsAssignedObserver::execute():

Copy
   public function execute(EventObserver $observer)
   {
   ..
      $this->eventDispatcher->dispatch('assigned_theme_changed', ['theme' => $theme]);
   }
Copied to your clipboard
   public function execute(EventObserver $observer)
   {
   ..
      $this->eventDispatcher->dispatch('assigned_theme_changed', ['theme' => $theme]);
   }

• theme is an object of \Magento\Framework\View\Design\ThemeInterface

Classes raising the event

• \Magento\Theme\Observer\CheckThemeIsAssignedObserver

assign_theme_to_stores_after

Use cases

To perform actions after a new theme is assigned to a store.

Origins

\Magento\Theme\Model\Config::assignToStore():

Copy
   public function assignToStore(...)
   {
   ..
      $this->_eventManager->dispatch(
         'assign_theme_to_stores_after',
         ['stores' => $stores, 'scope' => $scope, 'theme' => $theme]
      );
   }
Copied to your clipboard
   public function assignToStore(...)
   {
   ..
      $this->_eventManager->dispatch(
         'assign_theme_to_stores_after',
         ['stores' => $stores, 'scope' => $scope, 'theme' => $theme]
      );
   }

• stores is an array of stores
• scope - scope value defined in \Magento\Store\Model\ScopeInterface
• theme is an object of \Magento\Framework\View\Design\ThemeInterface

Classes raising the event

• \Magento\Theme\Model\Config

backend_auth_user_login_failed

Use cases

To perform actions after a backend login attempt has failed.

Origins

\Magento\Backend\Model\Auth::login():

Copy
   public function login($username, $password)
   {
   ..
      } catch (PluginAuthenticationException $e) {
         $this->_eventManager->dispatch(
               'backend_auth_user_login_failed',
               ['user_name' => $username, 'exception' => $e]
         );
         throw $e;
      } catch (\Magento\Framework\Exception\LocalizedException $e) {
         $this->_eventManager->dispatch(
               'backend_auth_user_login_failed',
               ['user_name' => $username, 'exception' => $e]
         );
   }
Copied to your clipboard
   public function login($username, $password)
   {
   ..
      } catch (PluginAuthenticationException $e) {
         $this->_eventManager->dispatch(
               'backend_auth_user_login_failed',
               ['user_name' => $username, 'exception' => $e]
         );
         throw $e;
      } catch (\Magento\Framework\Exception\LocalizedException $e) {
         $this->_eventManager->dispatch(
               'backend_auth_user_login_failed',
               ['user_name' => $username, 'exception' => $e]
         );
   }

• user_name - username string
• exception is an object of \Magento\Framework\Exception\LocalizedException or \Magento\Framework\Exception\Plugin\AuthenticationException

Classes raising the event

• \Magento\Backend\Model\Auth

backend_auth_user_login_success

Use cases

To perform actions after a successful backend login attempt.

Origins

\Magento\Backend\Model\Auth::login():

Copy
   public function login($username, $password)
   {
   ..
               $this->_eventManager->dispatch(
                  'backend_auth_user_login_success',
                  ['user' => $this->getCredentialStorage()]
               );
   }
Copied to your clipboard
   public function login($username, $password)
   {
   ..
               $this->_eventManager->dispatch(
                  'backend_auth_user_login_success',
                  ['user' => $this->getCredentialStorage()]
               );
   }

• user is an object of \Magento\Backend\Model\Auth\Credential\StorageInterface

Classes raising the event

• \Magento\Backend\Model\Auth

backend_block_widget_grid_prepare_grid_before

Use cases

To perform actions before a backend grid is prepared.

Origins

\Magento\Backend\Block\Widget\Grid::_prepareGrid():

Copy
   protected function _prepareGrid()
   {
      $this->_eventManager->dispatch(
         'backend_block_widget_grid_prepare_grid_before',
         ['grid' => $this, 'collection' => $this->getCollection()]
      );
   }
Copied to your clipboard
   protected function _prepareGrid()
   {
      $this->_eventManager->dispatch(
         'backend_block_widget_grid_prepare_grid_before',
         ['grid' => $this, 'collection' => $this->getCollection()]
      );
   }

• this is an object of \Magento\Backend\Block\Widget\Grid
• collection is an object of \Magento\Framework\Data\Collection

Classes raising the event

• \Magento\AdvancedSearch\Block\Adminhtml\Search\Grid
• \Magento\Newsletter\Block\Adminhtml\Subscriber\Grid

braintree_googlepay_update_quote_after

Use cases

To perform actions after braintree updates a quote.

Origins

\PayPal\Braintree\Model\GooglePay\Helper\QuoteUpdater::updateQuote():

Copy
   private function updateQuote(Quote $quote, array $details)
   {
   ...
      $this->eventManager->dispatch('braintree_googlepay_update_quote_after', [
         'quote' => $quote,
         'googlepay_response' => $details
      ]);
   }
Copied to your clipboard
   private function updateQuote(Quote $quote, array $details)
   {
   ...
      $this->eventManager->dispatch('braintree_googlepay_update_quote_after', [
         'quote' => $quote,
         'googlepay_response' => $details
      ]);
   }

• quote is an object of \Magento\Quote\Model\Quote
• googlepay_response is a response array

Classes raising the event

• \PayPal\Braintree\Model\GooglePay\Helper\QuoteUpdater

braintree_googlepay_update_quote_before

Use cases

To perform actions before braintree updates a quote.

Origins

• \PayPal\Braintree\Model\GooglePay\Helper\QuoteUpdater::updateQuote():

  Copy
   private function updateQuote(Quote $quote, array $details)
   {
       $this->eventManager->dispatch('braintree_googlepay_update_quote_before', [
           'quote' => $quote,
           'googlepay_response' => $details
       ]);
   }
  Copied to your clipboard
   private function updateQuote(Quote $quote, array $details)
   {
       $this->eventManager->dispatch('braintree_googlepay_update_quote_before', [
           'quote' => $quote,
           'googlepay_response' => $details
       ]);
   }

• quote is an object of \Magento\Quote\Model\Quote

• googlepay_response is a response array

Classes raising the event

• \PayPal\Braintree\Model\GooglePay\Helper\QuoteUpdater

braintree_paypal_update_quote_after

Use cases

To perform actions after Braintree updates a quote.

Origins

\PayPal\Braintree\Model\Paypal\Helper\QuoteUpdater::updateQuote():

Copy
   private function updateQuote(Quote $quote, array $details)
   {
   ...
      $this->eventManager->dispatch('braintree_paypal_update_quote_before', [
         'quote' => $quote,
         'paypal_response' => $details
      ]);
   }
Copied to your clipboard
   private function updateQuote(Quote $quote, array $details)
   {
   ...
      $this->eventManager->dispatch('braintree_paypal_update_quote_before', [
         'quote' => $quote,
         'paypal_response' => $details
      ]);
   }

• quote is an object of \Magento\Quote\Model\Quote
• paypal_response is a response array

Classes raising the event

• \PayPal\Braintree\Model\Paypal\Helper\QuoteUpdater

braintree_paypal_update_quote_before

Use cases

To perform actions before Braintree updates a quote.

Origins

\PayPal\Braintree\Model\Paypal\Helper\QuoteUpdater::updateQuote():

Copy
   private function updateQuote(Quote $quote, array $details)
   {
      $this->eventManager->dispatch('braintree_paypal_update_quote_before', [
         'quote' => $quote,
         'paypal_response' => $details
      ]);
   }
Copied to your clipboard
   private function updateQuote(Quote $quote, array $details)
   {
      $this->eventManager->dispatch('braintree_paypal_update_quote_before', [
         'quote' => $quote,
         'paypal_response' => $details
      ]);
   }

• quote is an object of \Magento\Quote\Model\Quote
• paypal_response is a response array

Classes raising the event

• \PayPal\Braintree\Model\Paypal\Helper\QuoteUpdater

catalogrule_dirty_notice

Use cases

To perform actions when some catalog rules have changed but changes have not been applied yet.

Origins

\Magento\CatalogRule\Controller\Adminhtml\Promo\Catalog\Index::execute():

Copy
   public function execute()
   {
      $dirtyRules = $this->_objectManager->create(\Magento\CatalogRule\Model\Flag::class)->loadSelf();
      $this->_eventManager->dispatch(
         'catalogrule_dirty_notice',
         ['dirty_rules' => $dirtyRules, 'message' => $this->getDirtyRulesNoticeMessage()]
      );
   }
Copied to your clipboard
   public function execute()
   {
      $dirtyRules = $this->_objectManager->create(\Magento\CatalogRule\Model\Flag::class)->loadSelf();
      $this->_eventManager->dispatch(
         'catalogrule_dirty_notice',
         ['dirty_rules' => $dirtyRules, 'message' => $this->getDirtyRulesNoticeMessage()]
      );
   }

• dirty_rules is an object of \Magento\CatalogRule\Model\Flag
• message is a message string

Classes raising the event

• \Magento\CatalogRule\Controller\Adminhtml\Promo\Catalog\Index

catalogsearch_reset_search_result

Use cases

To perform actions when search results are reset.

Origins

• \Magento\CatalogSearch\Model\ResourceModel\Fulltext::resetSearchResults():

  Copy
   public function resetSearchResults()
   {
   ...
       $this->_eventManager->dispatch('catalogsearch_reset_search_result');
       return $this;
   }
  Copied to your clipboard
   public function resetSearchResults()
   {
   ...
       $this->_eventManager->dispatch('catalogsearch_reset_search_result');
       return $this;
   }

• \Magento\CatalogSearch\Model\ResourceModel\Fulltext::resetSearchResultsByStore():

  Copy
   public function resetSearchResultsByStore($storeId)
   {
   ...
       $this->_eventManager->dispatch('catalogsearch_reset_search_result', ['store_id' => $storeId]);
  
  Copied to your clipboard
   public function resetSearchResultsByStore($storeId)
   {
   ...
       $this->_eventManager->dispatch('catalogsearch_reset_search_result', ['store_id' => $storeId]);
  
  

store_id is a store identifier.

Classes raising the event