Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
PrestaShop Module Development
PrestaShop Module Development

PrestaShop Module Development: Develop and customize powerful modules for PrestaShop 1.5 and 1.6

eBook
$9.99 $32.99
Paperback
$54.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Table of content icon View table of contents Preview book icon Preview Book

PrestaShop Module Development

Chapter 2. Hooks

A hook is the most essential concept to understand if you want to code a PrestaShop module, but as you will see, it's very easy.

Hooks are points on which you can attach modules in a way to change the normal behavior of the shop. In the PrestaShop 1.5/1.6 source code, their names are usually prefixed with display or action, depending on their purpose.

The display type hooks are generally used to add HTML or JS code on all or specific pages (for example, to add a block in a column, add an accessories link on a product page, add a field in a form, add information on a confirmation order page, and so on).

The action type hooks are used to change the behavior of the software by adding actions when events are triggered (for example, to add loyalty points to a customer when he or she places an order, logging modifications when a product is updated, send an e-mail to the merchant when a product is out of stock, and so on).

In this chapter, we will:

  • Register a module...

Registering our module on hooks

In your module, you will have to create an install method and register all the hooks you want your module to be attached to in the method. In the case of the module we started in the previous chapter, we want to display grades and comments on product pages, so we have to attach the module to one of the hooks that are available on the product page, such as displayProductTabContent.

Note

The displayProductTabContent hook is a hook that permits to display content at the end of the product page. The exhaustive list of native hooks is available at the end of this book.

We will add the displayProductTabContent hook with the help of the following code:

public function install()
{
  parent::install();
  $this->registerHook('displayProductTabContent');
  return true;
}

The parent install method is doing some pretty important processes, such as adding the module in the ps_module SQL table. So if you don't call it in your own install method, your module...

Changing the position of your module on a hook

You have to know that a module attached to a hook has a position. The positions represent the order in which the modules are called. When you attach a module to a hook, the module will be automatically set in the last position. However, you will be able, for most of the hooks, to change the order of the modules in PrestaShop's back office (by navigating to Main menu | Modules | Positions).

In our case, if you didn't install any other module than mymodcomments since you installed your shop, you should have only one other module attached to the hook: displayProductTabContent that results in Product Comments (which is a module similar to the one we are creating):

Changing the position of your module on a hook

As you can see, the position number and arrows are displayed for each module attached to this hook. You can change the position either by clicking on the position of My Module of product comments, and without releasing your click, drag it up just above the Product Comments module...

Using hooks to display templates

Let's come back to our main goal here: we want to add the possibility for customers to rate and comment on products. We first have to create a form for the customers. In order to avoid HTML code in PHP files, we will use what we learned in the previous chapter:

  1. Create a template for the hook:
    views/templates/hook/displayProductTabContent.tpl
  2. Use the display method in the hookDisplayProductTabContent function:
    return $this->display(__FILE__, 'displayProductTabContent.tpl');
  3. Then, write a simple form in the displayProductTabContent.tpl template we just created:
    <h3 class="page-product-heading">Product Comments</h3>
    <div class="rte">
      <form action="" method="POST" id="comment-form">
        <div class="form-group">
          <label for="grade">Grade:</label>
          <div class="row">
            <div class="col-xs-4"&gt...

Using the database class to save comments

We will now register the comment and grade filled in by the visitor in the database. First, we will create a table in our database:

CREATE TABLE IF NOT EXISTS ps_mymod_comment (id_mymod_comment int(11) NOT NULL AUTO_INCREMENT, id_product` int(11) NOT NULL, grade tinyint(1) NOT NULL, comment text NOT NULL,date_add datetime NOT NULL,PRIMARY KEY (id_mymod_comment)) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;

As you can see, the table contains five fields: the line identifier (in auto-increment), the product identifier, the grade, the comment, and the date of the comment.

Note

In PrestaShop, the naming conventions for the database field are:

  • Name your identifier field with the id_ prefix followed by the name of the table without the ps_ prefix
  • Name your date with the date_ prefix, such as date_comment

Create your table with your SQL admin tool (mine is phpMyAdmin; yeah, I know, I'm a bit old school). Beware! If you chose a different prefix than...

Displaying comments

The last step will be to display comments filled in by customers on the front office, and we will also use the configuration values we created in the previous chapter. Let's begin by creating a method named assignProductTabContent, where we will retrieve the concerned id_product parameter (which is in the GET value):

$id_product = Tools::getValue('id_product');

Then make the SQL request to retrieve all comments concerning the products of the page you are on:

$comments = Db::getInstance()->executeS('SELECT * FROM '._DB_PREFIX_.'mymod_comment WHERE id_product = '.(int)$id_product);

Note

You should have noticed that I used the _DB_PREFIX_ constant, which corresponds to the prefix you chose when you installed your shop. In most cases, it will be equal to ps_. We didn't use it for the insert method since the insert and update methods automatically add the prefix.

Then retrieve the configuration values and assign all these variables to...

Registering our module on hooks


In your module, you will have to create an install method and register all the hooks you want your module to be attached to in the method. In the case of the module we started in the previous chapter, we want to display grades and comments on product pages, so we have to attach the module to one of the hooks that are available on the product page, such as displayProductTabContent.

Note

The displayProductTabContent hook is a hook that permits to display content at the end of the product page. The exhaustive list of native hooks is available at the end of this book.

We will add the displayProductTabContent hook with the help of the following code:

public function install()
{
  parent::install();
  $this->registerHook('displayProductTabContent');
  return true;
}

The parent install method is doing some pretty important processes, such as adding the module in the ps_module SQL table. So if you don't call it in your own install method, your module won't be installable...

Changing the position of your module on a hook


You have to know that a module attached to a hook has a position. The positions represent the order in which the modules are called. When you attach a module to a hook, the module will be automatically set in the last position. However, you will be able, for most of the hooks, to change the order of the modules in PrestaShop's back office (by navigating to Main menu | Modules | Positions).

In our case, if you didn't install any other module than mymodcomments since you installed your shop, you should have only one other module attached to the hook: displayProductTabContent that results in Product Comments (which is a module similar to the one we are creating):

As you can see, the position number and arrows are displayed for each module attached to this hook. You can change the position either by clicking on the position of My Module of product comments, and without releasing your click, drag it up just above the Product Comments module, or by...

Using hooks to display templates


Let's come back to our main goal here: we want to add the possibility for customers to rate and comment on products. We first have to create a form for the customers. In order to avoid HTML code in PHP files, we will use what we learned in the previous chapter:

  1. Create a template for the hook:

    views/templates/hook/displayProductTabContent.tpl
  2. Use the display method in the hookDisplayProductTabContent function:

    return $this->display(__FILE__, 'displayProductTabContent.tpl');
  3. Then, write a simple form in the displayProductTabContent.tpl template we just created:

    <h3 class="page-product-heading">Product Comments</h3>
    <div class="rte">
      <form action="" method="POST" id="comment-form">
        <div class="form-group">
          <label for="grade">Grade:</label>
          <div class="row">
            <div class="col-xs-4">
              <select id="grade" class="form-control" name="grade">
                <option value="0"&gt...

Using the database class to save comments


We will now register the comment and grade filled in by the visitor in the database. First, we will create a table in our database:

CREATE TABLE IF NOT EXISTS ps_mymod_comment (id_mymod_comment int(11) NOT NULL AUTO_INCREMENT, id_product` int(11) NOT NULL, grade tinyint(1) NOT NULL, comment text NOT NULL,date_add datetime NOT NULL,PRIMARY KEY (id_mymod_comment)) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;

As you can see, the table contains five fields: the line identifier (in auto-increment), the product identifier, the grade, the comment, and the date of the comment.

Note

In PrestaShop, the naming conventions for the database field are:

  • Name your identifier field with the id_ prefix followed by the name of the table without the ps_ prefix

  • Name your date with the date_ prefix, such as date_comment

Create your table with your SQL admin tool (mine is phpMyAdmin; yeah, I know, I'm a bit old school). Beware! If you chose a different prefix than ps_...

Left arrow icon Right arrow icon

Description

If you are a developer who is new to PrestaShop and wants to get a good foundation in development on the PrestaShop framework, this book is for you. It's assumed that you will have some experience with PHP5, jQuery, and HTML/CSS (no need to be an expert on it).

What you will learn

  • Code your own module from scratch
  • Explore best practices for database table creation
  • Use hooks or implement overrides
  • Discover the many native methods available in PrestaShop
  • Make new administration tools
  • Create fully functional payment modules
  • Develop carrier modules
  • Secure and optimize your modules
  • Build functionalities compliant with the multistore feature
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Nov 28, 2014
Length: 254 pages
Edition : 1st
Language : English
ISBN-13 : 9781783280254
Languages :
Concepts :
Tools :

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Publication date : Nov 28, 2014
Length: 254 pages
Edition : 1st
Language : English
ISBN-13 : 9781783280254
Languages :
Concepts :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 152.97
PrestaShop Module Development
$54.99
Bootstrap Site Blueprints
$48.99
PrestaShop 1.5 Beginner's Guide
$48.99
Total $ 152.97 Stars icon
Banner background image

Table of Contents

12 Chapters
1. Creating a New Module Chevron down icon Chevron up icon
2. Hooks Chevron down icon Chevron up icon
3. Using Context and its Methods Chevron down icon Chevron up icon
4. Building Module Updates Chevron down icon Chevron up icon
5. Front Controllers, Object Models, and Overrides Chevron down icon Chevron up icon
6. Admin Controllers and Hooks Chevron down icon Chevron up icon
7. The Carrier Module Chevron down icon Chevron up icon
8. The Payment Module Chevron down icon Chevron up icon
9. Multistore Chevron down icon Chevron up icon
10. Security and Performance Chevron down icon Chevron up icon
A. Native Hooks Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Top Reviews
Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.5
(15 Ratings)
5 star 66.7%
4 star 20%
3 star 6.7%
2 star 6.7%
1 star 0%
Filter icon Filter
Top Reviews

Filter reviews by




Vicente Pérez Linares Nov 08, 2018
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Quizá algo más superficial de lo esperado, pero sin duda con él se aprende a desarrollar módulos
Amazon Verified review Amazon
Andre Gugliotti Dec 28, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
I've been working with Magento for several years and now I decided to take a look over PrestaShop. After having tips here and there, via internet tutorials, I bought this book. I really recommend it as I could learn a lot. Fabien Serny explains everything in a easy way, doesn't waste our time and cover almost every topic you need to know on PrestaShop modules development.PS: just to make it clear, if you are looking for installation and themes development, this is not the right book for you.
Amazon Verified review Amazon
Alessandro Feb 10, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Prestashop documentation is an area that needs improvement and this book is a much needed help.It follows a very practical approach and guides to the development of some useful custom modules with source code commentary and some insights to the general Prestashop architecture, the book is well written and concise.It helped me to get a better confidence with the platform and gave a boost to the development of a custom module I'm working to.Here are the chapters:Table of ContentsPreface1. Creating a New Module2. Hooks3. Using Context and its Methods4. Building Module Updates5. Front Controllers, Object Models, and Overrides6. Admin Controllers and Hooks7. The Carrier Module8. The Payment Module9. Multistore10. Security and PerformanceAppendix: Native HooksIndex
Amazon Verified review Amazon
Matteo Nardi Mar 27, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Veramente un ottimo libro per lo sviluppo di moduli prestashop personali. Completo e con esempi ben presentati e spiegati. Consigliato.
Amazon Verified review Amazon
Fabio Mar 12, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Il libro affronta praticamente lo sviluppodi un modulo completo curandone tutti gliaspetti riga per riga e spiegandone il motivo.La lettura è molto piacevole e scorrevole.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries: