Magento 2 – How to Get Category Tree

categorycategory-listingcategory-treemagento2

I need to show category tree, just like in admin section, in my custom page. I viewed this solution in magento.stackexchange.com. It was good but limited to 2 levels of category. I need all the categories. How can it be done?

Best Answer

I searched over internet for solution to this but got nothing useful. Then I diverted my research towards Magento core where I found \Magento\Catalog\Block\Adminhtml\Category\Tree class where I found a function getTree(). Then I tried to observed it's return value in my custom template file. The effort became fruitful as I got the desired result.

I created a block file where I have injected the above class as:

<?php
namespace Vendor\Module\Block;

class CategoriesColle extends \Magento\Framework\View\Element\Template
{

    ...
    protected $adminCategoryTree;

    /**
     * @param \Magento\Framework\View\Element\Template\Context $context
     * @param \Magento\Catalog\Helper\Category $categoryHelper
     * @param array $data
     */
    public function __construct(

       ...
        \Magento\Catalog\Block\Adminhtml\Category\Tree $adminCategoryTree

    )
    {
        ...
        $this->adminCategoryTree = $adminCategoryTree;

    }
    public function getTree()
    {
        return $this->adminCategoryTree->getTree(); 
    }
...

}

The return value of the getTree() is the desired array of the category tree which can be verified by dumping the value in template file.

Related Solutions

Magento 1.9 Category – Get Category Tree as an Assoc Array

Ok, based on your Updated Question:

You can iterate the collection without use ->toArray() method
If you want to exclude the root categories add ->addAttributeToFilter('level', array('gt' => 2))

Then you can use path to sort and create the tree, you can achieve this in many ways iterating the collection and exploding the path. Ordering categories by path you will ensure create first the parents and then the childs, don't forget to use the category_id as key in the array

Alternatively you can use the built-in tree:

Mage_Catalog_Helper_Category::getStoreCategories(...)

that retrieves a

Varien_Data_Tree_Node_Collection

But you can't export it to array directly, you must itarate it and get the childs recursively for each node to get a nested array.

Magento – Get child categories tree when Flat Catalog Category is enabled in admin in Magento 2

You can use getChildren to get child category data in your block even Use Flat Catalog Category is enabled.

For example

namespace Custom\Module\Block\World;
class Index extends \Magento\Framework\View\Element\Template
{
    protected $_categoryFactory;
    protected $_category;
    protected $_categoryHelper;
    protected $_categoryRepository;

    public function __construct(
        \Magento\Backend\Block\Template\Context $context,        
        \Magento\Catalog\Model\CategoryFactory $categoryFactory,
        \Magento\Catalog\Helper\Category $categoryHelper,
        \Magento\Catalog\Model\CategoryRepository $categoryRepository,        
        array $data = []
    )
    {
        $this->_categoryFactory = $categoryFactory;        
        parent::__construct($context, $data);
    }
        /**
     * Get category object
     * Using $_categoryFactory
     *
     * @return \Magento\Catalog\Model\Category
     */
    public function getCategory($categoryId) 
    {
        $this->_category = $this->_categoryFactory->create();
        $this->_category->load($categoryId);        
        return $this->_category;
    }


    /**
     * Retrieve children ids comma separated
     *
     * @return string
     */
    public function getChildren($categoryId = false)
    {
        if ($this->_category) {
            return $this->_category->getChildren();
        } else {
            return $this->getCategory($categoryId)->getChildren();
        }        
    }  



}

Inside the phtml template.

$test =  $block->getChildren('20');
echo "<pre>";
print_r($test);

Out put

Reference link for more details.

Recommended to pass classes to constructor as a dependency.

Hope it helps.

Best Answer

Related Solutions

Magento 1.9 Category – Get Category Tree as an Assoc Array

Magento – Get child categories tree when Flat Catalog Category is enabled in admin in Magento 2

Related Topic