Kdjykuj

The homepage of my magento website is showing a product list. This product list was made with the catalog product list widget configured to show the products which are in the homepage category. Products in this category have a position number. Products are displayed in what seems to be price ordered list. How do I get the widget to display position ordered list ?

Right, so old question but relevant for me. Sadly there wasn't an answer so I had to fix it myself and figure I'll answer the question while I'm at it.

I'll document the work here, but the entire module is available at https://github.com/rianorie/magento2-sortcatalogwidget.

First things first, I poked around at the catalogwidget module in Magento and found MagentoCatalogWidgetBlockProductProductsList::createCollection. Which confirms there's no sorting functionality available. So, in comes a Plugin:

class AfterCreateCollection

{

    public function aftercreateCollection($subject, $result)

    {

        /**

         * @var MagentoCatalogModelResourceModelProductCollection $result

         * @var MagentoCatalogWidgetBlockProductProductsList $subject

         */



        // if there's a sort_by attribute defined, add a sort to the collection

        if ($subject->hasData('sort_by')) {



            // if there's a direction given, check and use that otherwise  use the default

            $direction = strtoupper($subject->getData('sort_direction'));

            if (!in_array($direction, [Select::SQL_DESC, Select::SQL_ASC])) {

                $direction = Select::SQL_DESC;

            }



            $result->setOrder($subject->getData('sort_by'), $direction);

        }



        return $result;

    }

}

This is a good start, but the admin doesn't allow to manually add attributes to a widget definition very easily. So, we add a definition for that as well.

In etc/widget.xml we do:

<?xml version="1.0" encoding="UTF-8"?>

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">

    <widget id="products_list">

        <parameters>

            <parameter name="sort_by" xsi:type="text" required="false" visible="true">

                <label translate="true">Attribute to sort the products by</label>

            </parameter>

            <parameter name="sort_direction" xsi:type="select" visible="true" required="false"

                       source_model="ElastomaticSortCatalogWidgetModelConfigSourceDirection">

                <label translate="true">Sort direction</label>

            </parameter>

        </parameters>

    </widget>

</widgets>

Aaand voila! Sorting for the catalog widget is now possible. I might add a dropdown for the product attribute field instead of the free-typing input in the module at some point, but this serves my purpose for now.

If you want order by position in the widget product list, you must do the next.

Namespace/CustomWidgets/etc/frontend/di.xml

<?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="MagentoCatalogWidgetBlockProductProductsList">

        <plugin name="custom_widgets_product_list" type="NamespaceCustomWidgetsPluginBlockProductProductsListPlugin"/>

    </type>

</config>

Namespace/CustomWidgets/Plugin/Block/Product/ProductsListPlugin.php

<?php    

namespace NamespaceCustomWidgetsPluginBlockProduct;



use MagentoCatalogModelResourceModelProductCollection;

use MagentoCatalogWidgetBlockProductProductsList;



/**

 * Class ProductsListPlugin

 */

class ProductsListPlugin

{



    /**

     * @param ProductsList $subject

     * @param Collection $result

     * @return Collection

     * @SuppressWarnings(PHPMD.UnusedFormalParameter)

     */

    public function afterCreateCollection(ProductsList $subject, Collection $result)

    {

        $result->getSelect()->order('cat_index_position asc');



        return $result;

    }

}

This order always is by the position of the root category. If you want order by a specific category, you must create a new custom widget for that.