Magento - Retrieve products with a specific attribute value

Question

In my block code I am trying to programatically retrieve a list of products that have a attribute with a specific value.

Alternately if that is not possible how would one retrieve all products then filter them to just list the products with a specific attribute?

Answer 1

Almost all Magento Models have a corresponding Collection object that can be used to fetch multiple instances of a Model.

To instantiate a Product collection, do the following

$collection = Mage::getModel('catalog/product')->getCollection();

Products are a Magento EAV style Model, so you'll need to add on any additional attributes that you want to return.

$collection = Mage::getModel('catalog/product')->getCollection();

//fetch name and orig_price into data
$collection->addAttributeToSelect('name'); 
$collection->addAttributeToSelect('orig_price');

There's multiple syntaxes for setting filters on collections. I always use the verbose one below, but you might want to inspect the Magento source for additional ways the filtering methods can be used.

The following shows how to filter by a range of values (greater than AND less than)

$collection = Mage::getModel('catalog/product')->getCollection();
$collection->addAttributeToSelect('name'); 
$collection->addAttributeToSelect('orig_price'); 

//filter for products whose orig_price is greater than (gt) 100
$collection->addFieldToFilter(array(
 array('attribute'=>'orig_price','gt'=>'100'),
)); 

//AND filter for products whose orig_price is greater than (lt) 130
$collection->addFieldToFilter(array(
 array('attribute'=>'orig_price','lt'=>'130'),
));

While this will filter by a name that equals one thing OR another.

$collection = Mage::getModel('catalog/product')->getCollection();
$collection->addAttributeToSelect('name'); 
$collection->addAttributeToSelect('orig_price'); 

//filter for products who name is equal (eq) to Widget A, or equal (eq) to Widget B
$collection->addFieldToFilter(array(
 array('attribute'=>'name','eq'=>'Widget A'),
 array('attribute'=>'name','eq'=>'Widget B'),  
));

A full list of the supported short conditionals (eq,lt, etc.) can be found in the _getConditionSql method in lib/Varien/Data/Collection/Db.php

Finally, all Magento collections may be iterated over (the base collection class implements on of the the iterator interfaces). This is how you'll grab your products once filters are set.

$collection = Mage::getModel('catalog/product')->getCollection();
$collection->addAttributeToSelect('name'); 
$collection->addAttributeToSelect('orig_price'); 

//filter for products who name is equal (eq) to Widget A, or equal (eq) to Widget B
$collection->addFieldToFilter(array(
 array('name'=>'orig_price','eq'=>'Widget A'),
 array('name'=>'orig_price','eq'=>'Widget B'),  
));

foreach ($collection as $product) {
 //var_dump($product);
 var_dump($product->getData());
}

Answer 2

This is a follow up to my original question to help out others with the same problem. If you need to filter by an attribute, rather than manually looking up the id you can use the following code to retrieve all the id, value pairs for an attribute. The data is returned as an array with the attribute name as the key.

function getAttributeOptions($attributeName) {
    $product = Mage::getModel('catalog/product');
    $collection = Mage::getResourceModel('eav/entity_attribute_collection')
              ->setEntityTypeFilter($product->getResource()->getTypeId())
              ->addFieldToFilter('attribute_code', $attributeName);

    $_attribute = $collection->getFirstItem()->setEntity($product->getResource());
    $attribute_options  = $_attribute->getSource()->getAllOptions(false);
    foreach($attribute_options as $val) {
        $attrList[$val['label']] = $val['value'];
    }   

    return $attrList;
}

Here is a function you can use to get products by their attribute set id. Retrieved using the previous function.

function getProductsByAttributeSetId($attributeSetId) {
   $products = Mage::getModel('catalog/product')->getCollection();
   $products->addAttributeToFilter('attribute_set_id',$attributeSetId);

   $products->addAttributeToSelect('*');

   $products->load();
   foreach($products as $val) {
     $productsArray[] = $val->getData();
  }

  return $productsArray;
}

Answer 3

Christian -

I am trying to implement the code follow-up you posted, but I keep getting "undefined" errors regarding the arrays in each function.

I'm also not sure, because I'm pretty much a newbie to some of this, if I am calling the functions properly.

Is it possible for you to post an example of how you are calling these functions and what values you are passing to them?

Answer 4

I'm not a coder but interested in doing this. Can you give me the steps on where and how to implement this? I presume I copy and paste the code and modified the attributes that I'm searching for, right? Where do place these codes at?

Answer 5

I have added line

$this->_productCollection->addAttributeToSelect('releasedate');

in app/code/core/Mage/Catalog/Block/Product/List.php on line 95 in function _getProductCollection()

and then call it in app/design/frontend/default/hellopress/template/catalog/product/list.phtml By writing code

__('Release Date: %s', $this->dateFormat($_product->getReleasedate())) ?>

Now it is working in Magento 1.4.x

Answer 6

Great post, thanks!

I'm able to get the id's but when l run getProductsByAttributeSetId(28) for example l don't get anything returned, why isn't it sending me an array of the product(s) that have this specific attribute value?