Integrations / Platforms / Magento 1 / Custom Events
May. 10, 2019

Custom Events

For developers, the extension provides custom events to hook custom code on top of Algolia Search extension.

You can learn how to use events in Using extension’s events tutorial.

Products#

algolia_products_index_before_set_settings#

Dispatches before pushing products’ index settings to Algolia.

Passed parameters:

  • $storeId
  • $indexSettings as data in Varien_Object object

Modifiable parameters:

  • $indexSettings as data in Varien_Object object

algolia_after_products_collection_build#

Dispatches after products collection creation.

Passed parameters:

  • $storeId
  • $collection as Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection

Modifiable parameters:

  • $collection as Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection

algolia_before_products_collection_load#

Dispatches before final products collection load.

Passed parameters:

  • $collection as Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection
  • $storeId

Modifiable parameters:

  • $collection

algolia_product_index_before#

Dispatches before fetching product’s attributes for indexing.

Passed parameters:

  • $product as Mage_Catalog_Model_Product
  • $indexedData as data in Varien_Object object

Modifiable parameters:

  • $indexedData as data in Varien_Object object

algolia_after_create_product_object#

Dispatches after fetching product’s attributes for indexing.

Passed parameters:

  • $product_data as data in Varien_Object object
  • $subProducts as array of sub products
  • $productObject as Mage_Catalog_Model_Product

Modifiable parameters:

  • $product_data as data in Varien_Object object

Categories#

algolia_categories_index_before_set_settings#

Dispatches before pushing categories’ index settings to Algolia.

Passed parameters:

  • $storeId
  • $indexSettings as data in Varien_Object object

Modifiable parameters:

  • $indexSettings as data in Varien_Object object

algolia_after_categories_collection_build#

Dispatches after categories collection creation.

Passed parameters:

  • $storeId
  • $collection as Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Collection

Modifiable parameters:

  • $collection

algolia_category_index_before#

Dispatches before fetching category’s attributes for indexing.

Passed parameters:

  • $category as Mage_Catalog_Model_Category
  • $indexedData as data in Varien_Object object

Modifiable parameters:

  • $indexedData as data in Varien_Object object

algolia_after_create_category_object#

Dispatches after fetching category’s attributes for indexing.

Passed parameters:

  • $indexedData as data in Varien_Object object
  • $category as Mage_Catalog_Model_Category

Modifiable parameters:

  • $indexedData as data in Varien_Object object

Pages#

algolia_pages_index_before_set_settings#

Dispatches before pushing pages’ index settings to Algolia.

Passed parameters:

  • $storeId
  • $indexSettings as data in Varien_Object object

Modifiable parameters:

  • $indexSettings as data in Varien_Object object

algolia_after_pages_collection_build#

Dispatches after pages collection creation.

Passed parameters:

  • $storeId
  • $collection as Mage_Cms_Model_Resource_Page_Collection

Modifiable parameters:

  • $collection

algolia_after_create_page_object#

Dispatches after fetching page’s attributes for indexing.

Passed parameters:

  • $indexedData as data in Varien_Object object
  • $page as Mage_Cms_Helper_Page

Modifiable parameters:

  • $indexedData as data in Varien_Object object

Suggestions#

algolia_suggestions_index_before_set_settings#

Dispatches before pushing suggestions’ index settings to Algolia.

Passed parameters:

  • $storeId
  • $indexSettings as data in Varien_Object object

Modifiable parameters:

  • $indexSettings as data in Varien_Object object

algolia_after_suggestions_collection_build#

Dispatches after suggestions collection creation.

Passed parameters:

  • $storeId
  • $collection as Mage_CatalogSearch_Model_Resource_Query_Collection

Modifiable parameters:

  • $collection

algolia_after_create_suggestion_object#

Dispatches after fetching suggestion’s attributes for indexing.

Passed parameters:

  • $indexedData as data in Varien_Object object
  • $suggestion as Mage_CatalogSearch_Model_Query

Modifiable parameters:

  • $indexedData as data in Varien_Object object

Additional sections#

algolia_additional_sections_index_before_set_settings#

Dispatches before pushing additional sections’ index settings to Algolia.

Passed parameters:

  • $storeId
  • $indexSettings as data in Varien_Object object

Modifiable parameters:

  • $indexSettings as data in Varien_Object object

algolia_additional_section_items_before_index#

Dispatches after fetching additional_section’s attributes for indexing.

Passed parameters:

  • $section
  • $record as data in Varien_Object object
  • $storeId

Modifiable parameters:

  • $record as data in Varien_Object object

Front-end configuration#

algolia_after_create_configuration#

Dispatches after front-end configuration creation.

Passed parameters:

  • $configuration as data in Varien_Object object

Modifiable parameters:

  • $configuration as data in Varien_Object object

Did you find this page helpful?