Our company constantly monitors the official Prestashop forum to be aware of the most common issues people face when using this system. And we see that a frequently asked question is how to create a custom sorting. So today we will show how to do this. At the end of the article you can download the ready-to-use module and customized tpl template product-sort.tpl. As an example we will add a new sorting for the field EAN13.
There is no need to display the whole module code. That is why we will just highlight the main points. So, how does Prestashop associate products with a catalog page? There is the function assignProductList of the controller CategoryController which is responsible for that. Below you can see the part of the code which is responsible exactly for defining products for a category.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
$hookExecuted = false; Hook::exec('actionProductListOverride', array( 'nbProducts' => &$this->nbProducts, 'catProducts' => &$this->cat_products, 'hookExecuted' => &$hookExecuted, )); //a very important hook for our module. We will use it. // The hook was not executed, standard working if (!$hookExecuted) { $this->context->smarty->assign('categoryNameComplement', ''); $this->nbProducts = $this->category->getProducts(null, null, null, $this->orderBy, $this->orderWay, true); $this->pagination((int)$this->nbProducts); // Pagination must be call after "getProducts" $this->cat_products = $this->category->getProducts($this->context->language->id, (int)$this->p, (int)$this->n, $this->orderBy, $this->orderWay); //If the hook has not been executed, then starts the standard function of the class Category::getProducts } |
For our purposes we will create a module with the name: belvg_customsortexample and register it for this hook:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
public function hookActionProductListOverride($params) { $id_category = Tools::getValue('id_category'); $id_lang = $this->context->language->id; $id_shop = $this->context->shop->id; $categoryObj = new Category($id_category, $id_lang, $id_shop); $n = abs((int)(Tools::getValue('n', ((isset($this->context->cookie->nb_item_per_page) && $this->context->cookie->nb_item_per_page >= 10) ? $this->context->cookie->nb_item_per_page : (int)Configuration::get('PS_PRODUCTS_PER_PAGE'))))); $p = abs((int)Tools::getValue('p', 1)); $order_by_values = array(0 => 'name', 1 => 'price', 2 => 'date_add', 3 => 'date_upd', 4 => 'position', 5 => 'manufacturer_name', 6 => 'quantity', 7 => 'ean13'); $order_way_values = array(0 => 'asc', 1 => 'desc'); $orderBy = Tools::strtolower(Tools::getValue('orderby', $order_by_values[(int)Configuration::get('PS_PRODUCTS_ORDER_BY')])); //here it is assumed that we get a new value for sorting $orderWay = Tools::strtolower(Tools::getValue('orderway', $order_way_values[(int)Configuration::get('PS_PRODUCTS_ORDER_WAY')])); $params['catProducts'] = $categoryObj->getProducts($id_lang, (int)$p, (int)$n, $orderBy, $orderWay); $params['hookExecuted'] = TRUE; //please note that if this value is not set as TRUE , then in any case the standard method Category::getProducts is called } |
We also need to override the behavior of the function getProducts of the class Category and function productSort of the controller CategoryController. Here we will highlight only the main points, which are necessary for proper functioning of our module:
|
1 2 3 4 5 |
Category::getProducts() : if ($order_by == 'id_product' || $order_by == 'date_add' || $order_by == 'date_upd' || $order_by == 'ean13') //added ean13 $order_by_prefix = 'p'; CategoryController:: productSort() : $order_by_values = array(0 => 'name', 1 => 'price', 2 => 'date_add', 3 => 'date_upd', 4 => 'position', 5 => 'manufacturer_name', 6 => 'quantity', 7 => 'ean13'); //custom ean13 field |
And the last step is to change the template product-sort.tpl. We need to add options for ean13 into the html element select:
|
1 2 3 |
{*custom ean13 field*} <option value="ean13:asc" {if $orderby eq 'ean13' AND $orderway eq 'asc'}selected="selected"{/if}>{l s='EAN13: A to Z'}</option> <option value="ean13:desc" {if $orderby eq 'ean13' AND $orderway eq 'desc'}selected="selected"{/if}>{l s='EAN13: Z to A'}</option> |
As a result a new sorting has been created. Hurray!
PrestaShop Development
Take your online store to the next level with BelVG PrestaShop Development
Visit the page
Partner With Us
Looking for a partner to grow your business? We are the right company to bring your webstore to success.
Talk to Andrey
Hi, Alex
The discounted price is dynamically calculated, so there is no easy way to sort by this type of value without decreasing the performance. The best way is to create a separate index table for storing this value and keep this table for sorting. I can’t describe in details how to make it within the comment, but you can get in touch with our great Support Team and they will prepare a quote about that and implement the feature into your store.
Hi Alex, I would like to be able to sort by discounted price (or specific price how it’s called in the platform) instead of the retail price (price with taxes). Is there an easy way to do that?
Hi Le Roux,
an idea is the same but flavored with features of the new version.
The main part of the code will be the same. Unfortunately, I don’t have a much time to describe everything, but you can contact our support team to ask for a paid support: [email protected]
Hi, I’am french,sorry for my english.
My question is how can I do the same for presta 1.6.17?
Thanks for help
yann
In our article we described about adding the field EAN13 field to the search, you should replace all mentions of
ean13to thedate_add.By the way in our article the
date_addfield have already exist: $order_by_values = array(0 => ‘name’, 1 => ‘price’, 2 => ‘date_add’, 3 => ‘date_upd’, 4 => ‘position’, 5 => ‘manufacturer_name’, 6 => ‘quantity’, 7 => ‘ean13’); //custom ean13 fieldHi,
Search in Prestashop returns results by “position” with desc
How can change it by date_add with desc ?
Thank you
Hi Alex, Mayor and Florin
I am sorry, but your questions aren’t simple and require a long time for description. Could you contact our Support Team at [email protected]? They will try to help you.
hello,
Please tell me if i would like to create a sort by discount, how could i do that?
Hi,
I want customers to be able to sort by: “location”…
How do i do this thanks?
Alex! Thanks it work’s like a charm! date_upd variable is even better for my need’s :)
Konrad,
Well actually you can do it as described in the article, but instead EAN13 field use id_product.
Hi Alex. Great contribution! Can you provide some hint how to set default sort by ID? Newest first (on top of product-list.tpl) ?
Much appreciated!
Alan,
Everything is possible:) But in this way you may need to take data from the other tables.
Great article there and it opened up for me.
Possible to do a simple sort by product attribute id ie. Attribute Group = Size and Attribute Id = 1 (S) etc? So the products without this product attribute does not show.
Spirоs,
The source code of my solution is open, you can modify it in any way in accordance with your requirements. If you are interested in some specific technical issue, please indicate that so I would be able to answer it. However, if you are not familiar with PHP, you may contact Valerie at [email protected]
Hello Alex,
Can I modify the module to work with the reference number of the products and not with ean13?
Is that possible?
Thank you…
Trus,
I would say that it is possible to do so, but you need to remember that the data about the product size is stored in another table.
Hi,
Can I add an attribute like size to the sort by list. or is there any other way to sort with attributes in the product category page. If would be great if I can replace sample EAN with size attribute.
Raffaele,
I recommend you to enable the module Blocklayered Navigation
Bruno,
Unfortunately sorting by Bestsellers requires a more complex approach than just changing of the parameter ORDER BY. Perhaps, in future we will dedicate a separate article to this problem, because this issue requires some development.
Hallo… great idea!
Can I use it to sort products by colors?
I made an attribute named “Color” which has values like “Blu, Brown, White, etc.”
how i sort by bestsales?
Using this example you can create a custom sorting. If you need advanced attribute search, you can check out how to change the search algorithm here.
Hi Alex,
thanks for this article, is it possible to add a search by 1 attribute using this method ?
Peter,
The thing is that the operating principle is described on the basis of the controller Category. But if you are using another controller, for example Search, you need to take into account that you need to transmit custom parameters into SQL. That is why the .zip file does not contain any examples with Search.
Hi Alex!
first, congratulations for your module!
But it works only in categories items.
Those items shown after a simple search (in search bar) continue ordering by title.
Error?
Thanks.
Anton,
Do you want to create your own controller that will display the collection of those products which satisfy a certain condition (the content of $my_products)?
As an example, I will show the code of our module Discounted items:
Hi Alex!
Is it possible to generate my own pagination if i have $product array with all product i need.
I try to do like this:
$this->context->smarty->assign(‘categoryNameComplement’, ”);
$this->nbProducts = count ($my_products);
$this->pagination((int)$this->nbProducts); // Pagination must be call after “getProducts”
$this->cat_products = $my_products;
but without success