Magento 2 How to get custom category attribute on frontend

Question

I have created a new category attribute using a setup script and now it is showing on the backend and assigned values (it is just a boolean attribute). the attribute name on EAV entity table is is_home_category .And now I'm trying to get its values on frontend

$categories = $this->getStoreCategories(true, true, true);

foreach ($categories as $category):
   echo $category->getIsHomeCategory()
endforeach;

But it returns nothing , could someone help me

Answer 1

Proper way is to in the Install/Upgrade script:

$eavSetup->addAttribute(
    \Magento\Catalog\Model\Category::ENTITY,
    'my_custom_attribute',
    [
        // ...
        'used_in_product_listing' => true, // for category pages
        'visible_on_front' => true, // for frontend??
        'is_used_in_grid' => true, // for category pages
        'is_visible_in_grid' => true // for category pages
    ]
);

also on the collection do:

$collection->addAttributeToSelect('my_custom_attribute')

and then in the template you can just call:

$category->getMyCustomAttribute()
// or
$category->getData('my_custom_attribute');

If still not work run below command:

php bin/magento in:reindex

Answer 2

Previous answers are correct only if you explicitly indicates which attributes you want with addAttributeToSelect('is_home_category') or addAttributeToFilter('is_home_category') but this has limitations.

If you want your attribute to be always loaded with addAttributeTSelect('*'), you also have to create a new file etc/catalog_attributes.xml in your module and put the following code in it:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Catalog:etc/catalog_attributes.xsd">
    <group name="catalog_category">
        <attribute name="is_home_category"/>
    </group>
</config>

Then flush your caches and now every new category collection with addAttributeToSelect('*') will contains the field is_home_category if the category has a value for this attribute.

Note that this XML file can also contains data for other type of entites like products, you can see a lot of its usages if your search in Magento's core modules.

Answer 3

In your extension you should override the Category model (which contains all the data) and add a method to obtain the new attribute. In this way you can get the data in your view.

So first you have to create a file app\code\VENDOR\EXTENSION-NAME\etc\di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/ObjectManager/etc/config.xsd">
    <preference for="Magento\Catalog\Model\Category" type="VENDOR\EXTENSION-NAME\Model\Category" />
</config>

If you already have this file, just add the <preference> tag.

Create the Category.php file in app\code\VENDOR\EXTENSION-NAME\Model\. This file should contain the following (or something like it):

<?php

namespace VENDOR\EXTENSION-NAME\Model;

class Category extends \Magento\Catalog\Model\Category
{
    public function getIsHomeCategory()
    {            
        return $this->getCustomAttribute('is_home_category');            
    }
}

Flush your cache, and now you should be able to call this getIsHomeCategory function.

Answer 4

You can use this:

$categoryId = 3;
$_objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$category = $_objectManager->create('Magento\Catalog\Model\Category')->load($categoryId);
echo $category->getName();
echo $category->getData('<attribute_code>');

Or you can do this:

namespace Vendor\Module\Block;
class CustomBlock extends \Magento\Framework\View\Element\Template 
{
protected $_categoryFactory;    

public function __construct(
\Magento\Catalog\Model\CategoryFactory $categoryFactory,
\Magento\Framework\View\Element\Template\Context $context,
) {
    $this->_categoryFactory = $categoryFactory;
    parent::__construct($context);
}

public function getCategoryData($attrCode)
{
    $categoryId = '43';
    $category = $this->_categoryFactory->create()->load($categoryId);
    $categoryAttributeName = $category->getData($attrCode);
    return $categoryName;
}
}