2012-11-26: Magento: Loading a category or product by URL key

Posted at 2012-11-26 19:08:43 by SHD

Sometimes you want to load a specific category (or product) in Magento. It's easy enough to load an object by its ID number, but magic numbers are bad. Besides, the number could differ between your development environment and the live production site. Fortunately, it is also possible to load an object by its url_key.

General properties of a category in Magento CMS

Normally, you might load a category by ID through the simple code $cat = Mage::getModel ('catalog/product')->load ($id);. To load the category by URL key, a bit more code is needed. Here's how:

<?php
$category 
Mage::getModel ('catalog/category')
            ->
getCollection ()
            ->
addAttributeToFilter ('url_key''sales'//load the "sales" category
            
->getFirstItem (); //only 1 result
?>

The same works with products (but use the catalog/product model instead of catalog/category).

Where's the name?

If you try to call getName() on the returned category object, it won't return the actual category name. You might not need it (for instance, when you're only querying the products in that category), but then again, you might. Even more so for product objects. You can tell Magento to include the name (or any other attribute) before querying it:

<?php
$category 
Mage::getModel ('catalog/category')
            ->
getCollection ()
            ->
addAttributeToSelect ('name'//include the "name" property in the returned object
            
->addAttributeToFilter ('url_key''sales')
            ->
getFirstItem ();
?>

What about the price?

Using that category to load products? You probably want to include at least the name of that product and the price you expect customers to pay for it. Here's another snippet:

<?php
$products 
$category->getProductCollection ()
                     ->
addAttributeToSelect ('name'//yes, I want the "name" property again
                     
->addFinalPrice () //and give me the price too!
                     
->setPageSize (3); //but only give me 3 products
foreach ($products as $product)
{
    
/* do stuff here */
}
?>

What about everything else?

If you really want to load everything about a product or category, use "*" as the parameter to addAttributeToSelect().

Tags:

Comments

Hi, just wanted to let you know that your code snippets all got jumbled togther on one line which is making your comments color out the rest of the code.

Posted at 2014-09-18 20:51:33 by Caleb

Post a comment

Note: HTML is not permitted, URLs will be linked automatically. Spam comments will result in a permanent ban.
Type these 4 symbols into the edit field