How to add custom product sorter in magento 2?

This article is a solution If you want to add new custom sorter or filter options such as below:

New product,
Name, Instock,
Price Low to high,
Price High to Low.

Create a custom module and follow the below step.

1. Create file di.xml on app/code/Magemonkeys/Sorting/etc

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">    
    <type name="Magento\Catalog\Model\Config">
        <plugin name="Magemonkeys_Sorting::addCustomSortOptions" type="Magemonkeys\Sorting\Plugin\Model\Config" />
    </type>
    <type name="Magento\Catalog\Block\Product\ProductList\Toolbar">
        <plugin name="Magemonkeys_Sorting::implementCustomSortOptions" type="Magemonkeys\Sorting\Plugin\Product\ProductList\Toolbar" />
    </type>
</config>

<?xml version="1.0"?>

</type>

</type>

</config>

2. Create file Config.php on app/code/Magemonkeys/Sorting/Plugin

<?php
namespace Magemonkeys\Sorting\Plugin\Model;

class Config
{    
    public function afterGetAttributeUsedForSortByArray(\Magento\Catalog\Model\Config $catalogConfig, $options)
    {
        //Remove default sorting options
        unset($options['position']);
        unset($options['name']);
        unset($options['price']);

        //New sorting options
        $options['newest'] = __('New product');        
        $options['is_salable'] = __('Stock');
        $options['name'] = __('Name');        
        $options['price_desc'] = __('Price High to Low');
        $options['price_asc'] = __('Price Low to High');

        return $options;
    }
}

<?php

namespace Magemonkeys\Sorting\Plugin\Model;

class Config

{

public function afterGetAttributeUsedForSortByArray(\Magento\Catalog\Model\Config $catalogConfig, $options)

{

//Remove default sorting options

unset($options['position']);

unset($options['name']);

unset($options['price']);

//New sorting options

$options['newest'] = __('New product');

$options['is_salable'] = __('Stock');

$options['name'] = __('Name');

$options['price_desc'] = __('Price High to Low');

$options['price_asc'] = __('Price Low to High');

return $options;

}

3. Create file Toolbar.php on app/code/Magemonkeys/Sorting/Product/ProductList

<?php
namespace Magemonkeys\Sorting\Plugin\Product\ProductList;

class Toolbar
{    
    public function aroundSetCollection(
        \Magento\Catalog\Block\Product\ProductList\Toolbar $toolbar,
        \Closure $proceed,
        $collection
    ) {
        $this->_collection = $collection;
        $currentOrder = $toolbar->getCurrentOrder();
        $currentDirection = $toolbar->getCurrentDirection();
        $result = $proceed($collection);

        if ($currentOrder) {
            switch ($currentOrder) {

            case 'newest':
                if ($currentDirection == 'desc') {
                    $this->_collection->getSelect()->order('e.created_at ASC');
                } elseif ($currentDirection == 'asc') {
                    $this->_collection->getSelect()->order('e.created_at DESC');
                }
            break;

            case 'is_salable': 
                if ($currentDirection == 'desc') {
                    $this->_collection->getSelect()->order('qty ASC');
                } elseif ($currentDirection == 'asc') {
                    $this->_collection->getSelect()->order('qty DESC');
                }               
                          
            break;            

            case 'name':
                if ($currentDirection == 'desc') {
                    $this->_collection->getSelect()->order('name ASC');
                } elseif ($currentDirection == 'asc') {
                    $this->_collection->getSelect()->order('name DESC');
                }
            break;

            case 'price_desc':            
                if ($currentDirection == 'desc') {
                    $this->_collection->getSelect()->order('price ASC');
                } elseif ($currentDirection == 'asc') {
                    $this->_collection->getSelect()->order('price DESC');
                }
            break;

            case 'price_asc':
                if ($currentDirection == 'desc') {
                    $this->_collection->getSelect()->order('price DESC');
                } elseif ($currentDirection == 'asc') {
                    $this->_collection->getSelect()->order('price ASC');
                }
            break;            

            default:        
                $this->_collection
                    ->setOrder($currentOrder, $currentDirection);
            break;

            }
        }        
        //var_dump($currentDirection);
        return $result;
    }
}

<?php

namespace Magemonkeys\Sorting\Plugin\Product\ProductList;

class Toolbar

{

public function aroundSetCollection(

\Magento\Catalog\Block\Product\ProductList\Toolbar $toolbar,

\Closure $proceed,

$collection

) {

$this->_collection = $collection;

$currentOrder = $toolbar->getCurrentOrder();

$currentDirection = $toolbar->getCurrentDirection();

$result = $proceed($collection);

if ($currentOrder) {

switch ($currentOrder) {

case 'newest':

if ($currentDirection == 'desc') {

$this->_collection->getSelect()->order('e.created_at ASC');

} elseif ($currentDirection == 'asc') {

$this->_collection->getSelect()->order('e.created_at DESC');

}

break;

case 'is_salable':

if ($currentDirection == 'desc') {

$this->_collection->getSelect()->order('qty ASC');

} elseif ($currentDirection == 'asc') {

$this->_collection->getSelect()->order('qty DESC');

}

break;

case 'name':

if ($currentDirection == 'desc') {

$this->_collection->getSelect()->order('name ASC');

} elseif ($currentDirection == 'asc') {

$this->_collection->getSelect()->order('name DESC');

}

break;

case 'price_desc':

if ($currentDirection == 'desc') {

$this->_collection->getSelect()->order('price ASC');

} elseif ($currentDirection == 'asc') {

$this->_collection->getSelect()->order('price DESC');

}

break;

case 'price_asc':

if ($currentDirection == 'desc') {

$this->_collection->getSelect()->order('price DESC');

} elseif ($currentDirection == 'asc') {

$this->_collection->getSelect()->order('price ASC');

}

break;

default:

$this->_collection

->setOrder($currentOrder, $currentDirection);

break;

}

//var_dump($currentDirection);

return $result;

}

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-63e097e9d1c95254598585/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Magento 2 Developer

Hire H. Shingala

Let’s have a call

Fill the form & Get Installation Support