How to Retrieve Option Labels for EAV Attributes in Magento 2: A Step-by-Step Guide

In Magento 2, EAV (Entity-Attribute-Value) attributes offer a flexible means to store and manage diverse data for entities like products, customers, and orders. Occasionally, you may need to access the label of a specific option linked with an attribute. This guide will lead you through the process of fetching option labels using the Magento\Eav\Model\Entity\Attribute\Option class within your module’s namespace.

Step 1: Set Up Your Module

Before starting, ensure you have a functional Magento 2 instance and have established your custom module.

Step 2: Create Your Class

1. In your module’s directory (app/code/YourNamespace/YourModule), create a new PHP class named OptionLabelRetriever under the Model directory.
2. Inject the necessary dependencies: Magento\Eav\Model\Config and Magento\Eav\Model\Entity\Attribute\OptionFactory.
3. Define a method, getOptionLabel, to retrieve the label of an option based on an attribute code and option ID.

namespace YourNamespace\YourModule\Model;

use Magento\Eav\Model\Config;
use Magento\Eav\Model\Entity\Attribute\OptionFactory;
use Magento\Catalog\Model\Product;

class OptionLabelRetriever
{
    protected $eavConfig;
    protected $optionFactory;

    public function __construct(
        Config $eavConfig,
        OptionFactory $optionFactory
    ) {
        $this->eavConfig = $eavConfig;
        $this->optionFactory = $optionFactory;
    }

    public function getOptionLabel($attributeCode, $optionId)
    {
        $attribute = $this->eavConfig->getAttribute(Product::ENTITY, $attributeCode);
        $option = $this->optionFactory->create()->setStoreId(0)->load($optionId);
        $label = '';

        if ($option->getId()) {
            $optionLabel = $attribute->getSource()->getOptionText($option->getId());
            if ($optionLabel !== false) {
                $label = $optionLabel;
            }
        }

        return $label;
    }
}

Step 3: Utilize the Class

Now, you can use the `OptionLabelRetriever` class to fetch option labels within your module.

namespace YourNamespace\YourModule\Model;

class YourClass
{
    protected $optionLabelRetriever;

    public function __construct(
        OptionLabelRetriever $optionLabelRetriever
    ) {
        $this->optionLabelRetriever = $optionLabelRetriever;
    }

    public function someMethod()
    {
        $attributeCode = 'color'; // Replace with your actual attribute code
        $optionId = 123; // Replace with the desired option ID
        $optionLabel = $this->optionLabelRetriever->getOptionLabel($attributeCode, $optionId);

        // Now you have the option label
        echo "Option Label: " . $optionLabel;
    }
}

Step 4: Testing and Validation

1. Ensure your Magento cache is cleared using the command php bin/magento cache:clean.
2. Implement the YourClass class in your codebase and call the getOptionLabel method with appropriate attribute code and option ID.
3. Test thoroughly to verify that the option label retrieval works as expected.

By following these steps, you’ve successfully implemented a solution for retrieving option labels for EAV attributes within the namespace of your custom Magento 2 module. This approach ensures clean and organized code, contributing to the maintainability of your Magento store.

Thank you so much for taking the time to read my article.