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
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
PrestaShop Module Development
PrestaShop Module Development

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

eBook
€28.99 €32.99
Paperback
€41.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with eBook?

Product feature icon Instant access to your Digital eBook purchase
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

Billing Address

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

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 : 9781783280261
Languages :
Concepts :
Tools :

What do you get with eBook?

Product feature icon Instant access to your Digital eBook purchase
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

Billing Address

Product Details

Publication date : Nov 28, 2014
Length: 254 pages
Edition : 1st
Language : English
ISBN-13 : 9781783280261
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 117.97
PrestaShop Module Development
€41.99
Bootstrap Site Blueprints
€37.99
PrestaShop 1.5 Beginner's Guide
€37.99
Total 117.97 Stars icon

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

How do I buy and download an eBook? Chevron down icon Chevron up icon

Where there is an eBook version of a title available, you can buy it from the book details for that title. Add either the standalone eBook or the eBook and print book bundle to your shopping cart. Your eBook will show in your cart as a product on its own. After completing checkout and payment in the normal way, you will receive your receipt on the screen containing a link to a personalised PDF download file. This link will remain active for 30 days. You can download backup copies of the file by logging in to your account at any time.

If you already have Adobe reader installed, then clicking on the link will download and open the PDF file directly. If you don't, then save the PDF file on your machine and download the Reader to view it.

Please Note: Packt eBooks are non-returnable and non-refundable.

Packt eBook and Licensing When you buy an eBook from Packt Publishing, completing your purchase means you accept the terms of our licence agreement. Please read the full text of the agreement. In it we have tried to balance the need for the ebook to be usable for you the reader with our needs to protect the rights of us as Publishers and of our authors. In summary, the agreement says:

  • You may make copies of your eBook for your own use onto any machine
  • You may not pass copies of the eBook on to anyone else
How can I make a purchase on your website? Chevron down icon Chevron up icon

If you want to purchase a video course, eBook or Bundle (Print+eBook) please follow below steps:

  1. Register on our website using your email address and the password.
  2. Search for the title by name or ISBN using the search option.
  3. Select the title you want to purchase.
  4. Choose the format you wish to purchase the title in; if you order the Print Book, you get a free eBook copy of the same title. 
  5. Proceed with the checkout process (payment to be made using Credit Card, Debit Cart, or PayPal)
Where can I access support around an eBook? Chevron down icon Chevron up icon
  • If you experience a problem with using or installing Adobe Reader, the contact Adobe directly.
  • To view the errata for the book, see www.packtpub.com/support and view the pages for the title you have.
  • To view your account details or to download a new copy of the book go to www.packtpub.com/account
  • To contact us directly if a problem is not resolved, use www.packtpub.com/contact-us
What eBook formats do Packt support? Chevron down icon Chevron up icon

Our eBooks are currently available in a variety of formats such as PDF and ePubs. In the future, this may well change with trends and development in technology, but please note that our PDFs are not Adobe eBook Reader format, which has greater restrictions on security.

You will need to use Adobe Reader v9 or later in order to read Packt's PDF eBooks.

What are the benefits of eBooks? Chevron down icon Chevron up icon
  • You can get the information you need immediately
  • You can easily take them with you on a laptop
  • You can download them an unlimited number of times
  • You can print them out
  • They are copy-paste enabled
  • They are searchable
  • There is no password protection
  • They are lower price than print
  • They save resources and space
What is an eBook? Chevron down icon Chevron up icon

Packt eBooks are a complete electronic version of the print edition, available in PDF and ePub formats. Every piece of content down to the page numbering is the same. Because we save the costs of printing and shipping the book to you, we are able to offer eBooks at a lower cost than print editions.

When you have purchased an eBook, simply login to your account and click on the link in Your Download Area. We recommend you saving the file to your hard drive before opening it.

For optimal viewing of our eBooks, we recommend you download and install the free Adobe Reader version 9.