...
All hooks in PrestaShop have been updated for version 1.5, and several new ones were added.
Note |
---|
The following "new hooks" and "updated hooks" lists were automatically generated by a script. Hook descriptions appear as they are in the PrestaShop database, and can sometimes be missing. |
New hooks since v1.4
Hook name | Hook description | What to expect in $params ? (Pseudocode) | |
---|---|---|---|
actionAdminMetaControllerUpdate_optionsBefore | |||
actionAdminMetaSave | After saving configuration in AdminMeta. | N/A | |
actionAuthentication | After authentication. | N/A | |
actionBeforeAuthentication | Before authentication. | N/A | |
actionCartSave | After saving the Cart object. | N/A | |
actionCustomerAccountAdd | Called when a new customer successfully creates account. |
| |
actionHtaccessCreate | After .htaccess creation. | ||
actionObjectCategoryDeleteAfter | |||
actionObjectCategoryUpdateAfter | |||
actionObjectCmsDeleteAfter | |||
actionObjectCmsUpdateAfter | |||
actionObjectManufacturerDeleteAfter | |||
actionObjectManufacturerUpdateAfter | |||
actionObjectProductDeleteAfter | |||
actionObjectProductUpdateAfter | |||
actionObjectSupplierDeleteAfter | |||
actionObjectSupplierUpdateAfter | |||
N/A | |||
actionObjectCategoryDeleteAfter | Not invoked by the PrestaShop core itself - can be used after deleting a category to notify the Horizonal Top Menu. | N/A | |
actionObjectCategoryUpdateAfter | Not invoked by the PrestaShop core itself - can be used after updating a category to notify the Horizontal Top Menu. | N/A | |
actionObjectCmsDeleteAfter | Not invoked by the PrestaShop core itself - can be used after deleting a CMS page to notify the Horizontal Top Menu. | N/A | |
actionObjectCmsUpdateAfter | Not invoked by the PrestaShop core itself - can be used after deleting a CMS page to notify the Horizontal Top Menu. | N/A | |
actionObjectManufacturerDeleteAfter | Not invoked by the PrestaShop core itself - can be used after deleting a manufacturer to notify the Horizontal Top Menu. | N/A | |
actionObjectManufacturerUpdateAfter | Not invoked by the PrestaShop core itself - can be used after updating a manufacturer to notify the Horizontal Top Menu. | N/A | |
actionObjectProductDeleteAfter | Not invoked by the PrestaShop core itself - can be used after deleting a product to notify the Horizontal Top Menu. | N/A | |
actionObjectProductUpdateAfter | Not invoked by the PrestaShop core itself - can be used after updating a product to notify the Horizontal Top Menu. | N/A | |
actionObjectSupplierDeleteAfter | Not invoked by the PrestaShop core itself - can be used after deleting a supplier to notify the Horizontal Top Menu. | N/A | |
actionObjectSupplierUpdateAfter | Not invoked by the PrestaShop core itself - can be used after updating a supplier to notify the Horizontal Top Menu. | N/A | |
actionOrderDetail | To set the follow-up in Smarty when order detail is called. | ||
actionOrderReturn | |||
| |||
actionOrderReturn | Called after a new Order Return has been made. |
| |
actionOrderSlipAdd | Called when a the quantity of one a product change changes in an order. WARNING: only invoked when a product is actually removed from an order. | ||
actionOrderStatusPostUpdate | |||
actionOrderStatusUpdate | Launch modules when the order's status changes. | ||
actionPaymentCCAdd | Payment CC added | ||
actionPaymentConfirmation | |||
actionSearch | |||
actionShopDataDuplication | |||
actionTaxManager | |||
actionUpdateQuantity | Quantity is updated only when the customer effectively place his order. | ||
actionValidateOrder | |||
actionWatermark | |||
displayAdminCustomers | Launch modules when the tab AdminCustomers is displayed on back-office. | ||
displayAdminOrder | Launch modules when the tab AdminOrder is displayed on back-office. | ||
displayAdminStatsGraphEngine | |||
displayAdminStatsGridEngine | |||
displayAdminStatsModules | |||
displayBackOfficeFooter | |||
displayBackOfficeHeader | |||
displayBackOfficeHome | |||
displayBackOfficeTop | |||
displayBeforeCarrier | This hook is display before the carrier list on Front office | ||
The order of IDs and quantities is important! | |||
actionOrderStatusPostUpdate | Called after the status of an order changes. |
| |
actionOrderStatusUpdate | Called before the status of an order changes. |
| |
actionPaymentCCAdd | Payment CC added |
| |
actionPaymentConfirmation | Called after a payment has been validated |
| |
actionSearch | After the search in the store. Includes both instant and normal search. |
| |
actionShopDataDuplication | After duplicating a shop. |
| |
actionTaxManager | Not used by PrestaShop core. | N/A | |
actionUpdateQuantity | After updating the quantity of a product. |
| |
actionValidateOrder | After an order has been validated. Doesn't necessarily have to be paid. |
| |
actionWatermark | After a watermark has been added to an image. |
| |
displayAdminCustomers | Can be used by modules when the tab AdminCustomers is displayed in the Back Office. | array( | |
displayAdminOrder | Can be used by modules when the tab AdminOrder is displayed in the Back Office. | array( | |
displayAdminStatsGraphEngine | Not used by PrestaShop core. | N/A | |
displayAdminStatsGridEngine | Not used by PrestaShop core. | N/A | |
displayAdminStatsModules | Used when the statistics page in the Back Office is shown. | N/A | |
displayBackOfficeFooter | Displayed right before the Back Office footer. | N/A | |
displayBackOfficeHeader | Displayed between the <head></head> tags on every Back Office page (when logged in). | N/A | |
displayBackOfficeHome | Displayed on the dashboard page of the Back Office. | N/A | |
displayBackOfficeTop | Shown above the actual content of a Back Office page | N/A | |
displayBeforeCarrier | This hook is displayed before the carrier list on the Front Office | array( NOTE: intified means an array of integers 'intified' by | |
displayBeforePayment | Redirect user to the module instead of displaying payment modules | ||
displayCarrierList | |||
| |||
displayCarrierList | Display extra carriers in the carrier list. |
| |
displayCustomerAccount | Display on page account of the customer. | N/A | |
displayCustomerAccountForm | Display some information on the form to create a customer account. | N/A | |
displayCustomerAccountFormTop | Display some information on the top of the form to create a customer account. | N/A | |
displayFooter | Add block in footer. | N/A | |
displayFooterProduct | Add new blocks under the product description. | N/A | |
displayHeader | A hook which allow you to do things in the header of each pages | ||
displayHome | |||
every page. | N/A | ||
displayHome | Display on content of home page. | N/A | |
displayInvoice | Add blocks to invoice (order). | N/A | |
displayLeftColumn | |||
displayLeftColumnProduct | |||
Display in left column. | N/A | ||
displayLeftColumnProduct | Display in left column on product page (not to be confused with the general left column). | N/A | |
displayMyAccountBlock | Display extra information inside the "my account" block | N/A | |
displayMyAccountBlockfooter | Display extra information inside the "my account" block | N/A | |
displayOrderConfirmation | Called on order confirmation page |
| |
displayOrderDetail | Displayed on order detail on front office | ||
displayPayment | |||
displayPaymentReturn | |||
| |||
displayPayment | Displayed on payment page | N/A | |
displayPaymentReturn | Displayed on payment return page |
| |
displayPaymentTop | Top of payment page | N/A | |
displayPDFInvoice | Allow the display of extra information into the PDF invoice | N/A | |
displayProductButtons | Put new action buttons on product page | N/A | |
displayProductComparison | Extra Product Comparison | N/A | |
displayProductTab | Called on order product page tabs | N/A | |
displayProductTabContent | Called on order product page tabs | ||
displayRightColumn | |||
displayRightColumnProduct | |||
| |||
displayRightColumn | Displayed in right column. |
Note that the | |
displayRightColumnProduct | Display in right column on product page (not to be confused with the general right column). | N/A | |
displayShoppingCart | Display some specific information | ||
displayShoppingCartFooter | Display some specific information on the shopping cart page | ||
displayTop | A hook which enables you to do things at the top of each page. | ||
displayHeader | A hook which allow you to do things in the header of each pages | ||
displayHome |
| ||
displayInvoice | Add blocks to invoice (order) | ||
displayLeftColumn |
| ||
displayLeftColumnProduct |
| ||
displayMyAccountBlock | Display extra information inside the "my account" block | ||
displayMyAccountBlockfooter | Display extra information inside the "my account" block | ||
displayOrderConfirmation | Called on order confirmation page | ||
displayOrderDetail | Displayed on order detail on front office | ||
displayPDFInvoice | Allow the display of extra information into the PDF invoice | ||
displayPayment |
| ||
displayPaymentReturn |
| ||
displayPaymentTop | Top of payment page | ||
displayProductButtons | Put new action buttons on product page | ||
displayProductComparison | Extra Product Comparison | ||
displayProductTab | Called on order product page tabs | ||
displayProductTabContent | Called on order product page tabs | ||
displayRightColumn |
| ||
displayRightColumnProduct |
| ||
displayShoppingCart | Display some specific information | ||
displayShoppingCartFooter | Display some specific information on the shopping cart page | ||
displayTop | A hook which enables you to do things at the top of each page.array( Can be found in | ||
displayShoppingCartFooter | Display some specific information on the shopping cart page | array( Can be found in |
Updated hooks since v1.4
Most of these hooks are the same as they were in version 1.4 of PrestaShop, but have been renamed with either an "action" or "display" prefix in order to be compatible with the new 1.5 naming scheme.
Note |
---|
The following "updated hooks" lists were automatically generated by a script. Hook descriptions appear as they are in the PrestaShop database, and can sometimes be missing. |
Old hook name | New hook name | Hook description |
---|---|---|
AdminStatsModules | displayAdminStatsModules |
|
GraphEngine | displayAdminStatsGraphEngine |
|
GridEngine | displayAdminStatsGridEngine |
|
PDFInvoice | displayPDFInvoice | Allow the display of extra information into the PDF invoice |
addproduct | actionProductAdd |
|
adminCustomers | displayAdminCustomers | Launch modules when the tab AdminCustomers is displayed on back-office. |
adminOrder | displayAdminOrder | Launch modules when the tab AdminOrder is displayed on back-office. |
afterCreateHtaccess | actionHtaccessCreate | After |
afterDeleteAttribute | actionAttributeDelete | On deleting attribute feature value |
afterDeleteAttributeGroup | actionAttributeGroupDelete | On deleting attribute group |
afterDeleteFeature | actionFeatureDelete | On deleting attribute feature |
afterDeleteFeatureValue | actionFeatureValueDelete | On deleting attribute feature value |
afterSaveAdminMeta | actionAdminMetaSave | After save configuration in AdminMeta |
afterSaveAttribute | actionAttributeSave | On saving attribute feature value |
afterSaveAttributeGroup | actionAttributeGroupSave | On saving attribute group |
afterSaveFeature | actionFeatureSave | On saving attribute feature |
afterSaveFeatureValue | actionFeatureValueSave | On saving attribute feature value |
afterSaveProduct | actionProductSave | On saving products |
attributeForm | displayAttributeForm | Add fields to the form "attribute value" |
attributeGroupForm | displayAttributeGroupForm | Add fields to the form "attribute group" |
authentication | actionAuthentication |
|
backBeforePayment | displayBeforePayment | Redirect user to the module instead of displaying payment modules |
backOfficeFooter | displayBackOfficeFooter |
|
backOfficeHeader | displayBackOfficeHeader |
|
backOfficeHome | displayBackOfficeHome |
|
backOfficeTop | displayBackOfficeTop |
|
beforeAuthentication | actionBeforeAuthentication | Before authentication |
beforeCarrier | displayBeforeCarrier | This hook is display before the carrier list on Front office |
cancelProduct | actionProductCancel | This hook is called when you cancel a product in an order |
cart | actionCartSave |
|
categoryAddition | actionCategoryAdd |
|
categoryDeletion | actionCategoryDelete |
|
categoryUpdate | actionCategoryUpdate |
|
createAccount | actionCustomerAccountAdd | Called when a new customer successfully creates an account |
createAccountForm | displayCustomerAccountForm | Display some information on the form to create a customer account |
createAccountTop | displayCustomerAccountFormTop |
|
customerAccount | displayCustomerAccount | Display on page account of the customer |
deleteProductAttribute | actionProductAttributeDelete |
|
deleteproduct | actionProductDelete | This hook is called when a product is deleted |
extraCarrier | displayCarrierList |
|
extraLeft | displayLeftColumnProduct |
|
extraProductComparison | displayProductComparison | Extra Product Comparison |
extraRight | displayRightColumnProduct |
|
featureForm | displayFeatureForm | Add fields to the form "feature" |
featureValueForm | displayFeatureValueForm | Add fields to the form "feature value" |
footer | displayFooter | Add block in footer |
header | displayHeader | A hook which allow you to do things in the header of each pages |
home | displayHome |
|
invoice | displayInvoice | Add blocks to invoice (order) |
leftColumn | displayLeftColumn |
|
myAccountBlock | displayMyAccountBlock | Display extra information inside the "my account" block |
newOrder | actionValidateOrder |
|
orderConfirmation | displayOrderConfirmation | Called on order confirmation page |
orderDetail | actionOrderDetail | To set the follow-up in Smarty when order detail is called |
orderDetailDisplayed | displayOrderDetail | Displayed on order detail on front office |
orderReturn | actionOrderReturn |
|
orderSlip | actionOrderSlipAdd | Called when a quantity of one product change in an order. |
payment | displayPayment |
|
paymentCCAdded | actionPaymentCCAdd | Payment CC added |
paymentConfirm | actionPaymentConfirmation |
|
paymentReturn | displayPaymentReturn |
|
paymentTop | displayPaymentTop | Top of payment page |
postProcessAttribute | actionAttributePostProcess | On post-process in admin feature value |
postProcessAttributeGroup | displayAttributeGroupPostProcess | On post-process in admin attribute group |
postProcessFeature | displayFeaturePostProcess | On post-process in admin feature |
postProcessFeatureValue | displayFeatureValuePostProcess | On post-process in admin feature value |
postUpdateOrderStatus | actionOrderStatusPostUpdate |
|
processCarrier | actionCarrierProcess |
|
productActions | displayProductButtons | Put new action buttons on product page |
productListAssign | actionProductListOverride | Assign product list to a category |
productOutOfStock | actionProductOutOfStock | Make action while product is out of stock |
productTab | displayProductTab | Called on order product page tabs |
productTabContent | displayProductTabContent | Called on order product page tabs |
productfooter | displayFooterProduct | Add new blocks under the product description |
rightColumn | displayRightColumn |
|
search | actionSearch |
|
shoppingCart | displayShoppingCartFooter | Display some specific information on the shopping cart page |
shoppingCartExtra | displayShoppingCart | Display some specific information |
taxManager | actionTaxManager |
|
top | displayTop | A hook which allow you to do things at the top of each pages. |
updateCarrier | actionCarrierUpdate | This hook is called when a carrier is updated |
updateOrderStatus | actionOrderStatusUpdate | Launch modules when the order's status changes. |
updateProductAttribute | actionProductAttributeUpdate |
|
updateQuantity | actionUpdateQuantity | Quantity is updated only when the customer effectively place his order. |
updateproduct | actionProductUpdate |
|
watermark | actionWatermark |
|
...