Magento Static Block

There’s more than one way to skin a hippo and adding CMS static blocks in Magento is no exception.

In case you’re unfamiliar with CMS static blocks, they are powerful little buggers in Magento’s admin that allows the site’s administrator to add and control chunks of HTML that can be displayed throughout the site. They’re perfect for seasonal banners, sale blocks, return policies, size charts and anything that would make sense to modularize to make maintaining your site easier.

But wait, aren’t there already ‘callouts’ in Magento? Well, if you’re talking about those annoying graphics of the dog and chalkboard that take editing multiple files to update then yes. Magento’s built-in callouts are a terrible way of handling regularly updated content.

Your Magento website should be as updatable as possible to keep you from getting phone calls every time a client wants to advertise a new sale. Which is exactly why we want to control these blocks from the admin. Keep in mind Magento’s upcoming release of 1.4 will be implementing a WYSIWIG editor so clients can handle their own changes instead of pestering you.

Creating a Static Block

1. Log into your Magento store’s admin
2. Navigate to CMS>Static Blocks
3. Click Add New Block in the top right corner
4. Give your block a recognizable Block Title such as Social Media Links or “Fall Sale Banner”
5. Give your block an Identifier which will be used to call the block. Make sure the Identifier is all lowercase and separated by underscores to follow Magento’s nomenclature i.e. your_block_id
6. Choose what store view the block belongs to. Just leave as All Store Views unless you have a good reason not to
7. Set Status to Enabled
8. Enter your HTML in the Content field. The editor is currently a raw HTML editor, but 1.4 will support a WYSIWIG editor. Alternately, there is a Magento WYSIWIG extention to help out.
9. Click Save Block or Save and Continue Edit to save your settings.

You’ve set up your block, so how do you plug it into your site? Well it depends on how you need it to function, but you have several options at your disposal:

1. XML

Adding a static block to a page template is a great way to control global elements of your site, such as footer links, custom callouts in the sidebar (ultimately replacing that damn dog) and more. You can embed this code in app > design > frontend > default > your_theme > layout. Open the appropriate the file, lets say catalog.xml and plunk the following code in the block for our category view:

<block type="cms/block" name="your_block_id" before="-">
      <action method="setBlockId"><block_id>your_block_id</block_id></action>
</block>

This code will place the block “your_block_id” that you have created in the admin above the content on the category pages (notice the before=”-” attribute, which makes sure your block gets displayed before the rest of the content). This is perfect for a seasonal banner that could advertise a current sale on all product listings.

Controlling static blocks with XML is geared for content that will remain in a consistent position in your theme.

Sometimes however you gotta get down and dirty and place your CMS static block inline in your template. That’s where the next method comes in.

2. PHP

Adding your static block inline with PHP is the quickest way to get your block in your template. Let’s say you want to add a quick blurb about your return policy right after the “Add to Cart” button. The client needs to be able to occassionaly update this blurb from time to keep it current. So you open your template file that contains the “Add to Cart” button app > design > frontend > default > your_theme > template > catalog > product > view > addtocart.phtml. Find the <button> tag and right afterwards add the following code:
[cc lang="php" tab_size="2" lines="40"]
<?php echo $this->getLayout()->createBlock('cms/block')->setBlockId('your_block_id')->toHtml(); ?>
[/cc]


This code will add the block “your_block_id” right after the button. Jobs done. This method is perfect for getting into those nooks and crannies in Magento’s vast and awkward file structure.

3. Shortcode

This method is used when you need to pull in a static block while in Magento’s admin creating CMS pages or other static blocks. A possible example would be injecting contact information into multiple CMS pages. So you create a contact static block, and then can insert the contact info on the contact us page, your privacy policy page, customer service page, etc. If the contact info changes, you simply update the static block and the changes will be reflected across all your CMS pages.

{{block type="cms/block" block_id="your_block_id"}}

This code will place the block “your_block_id” inline in your CMS page.

Conclusion

The whole idea of creating these static blocks is to streamline the amount of time it takes to update your site. Clients won’t have to bother you to change their 800 number. Your design team or site administer can simply FTP a new image and update the image path. Or if you own the site, you don’t have to go dumpster diving through your template files to find where you put that couple paragraphs of content.

Do you have a preferred method of adding a static blocks or creative uses of static blocks in your Magento site? Let me know in the comments.

Magento Beginner's Guide by Packt Publishing

Magento Ecommerce is a powerful, flexible open-source system that can produce great results right out of the box.  At Pod1, we work exclusively with Magento to deliver custom ecommerce websites for high end fashion brands and more.  Because I’ve seen an incredible amount of client success with Magento I’m quick to recommend it as an extremely capable  e-commerce solution.

While Magento is a great tool, its learning curve is steep (relative to other platforms) and reliable, thorough documentation is often hard to come by.

Enter the good people at Packt Publishing.   Their Magento books are invaluable tools of navigating a powerful but daunting platform.  I’ve read Magento 1.3 Theme Design and it does a great job explaining how to customize Magento, so when Packt asked me to review Magento Beginner’s Guide I knew I’d have  some great reading ahead of me.

Who This Book is For

Typically people asking me for e-commerce advice are small business owners or do-it-yourselfers who want an online presence that they can set up and manage themselves.   I recommend Magento to them because of its scalability so as their business grows, their e-commerce presence can grow with it.  However, everyone  who has taken my advice and decided on Magento usually come running back to me after about an hour saying “Sooooo, how exactly do you do this?” Several painstaking hours later they are online and ready to dig in.  I then get another call saying something along the lines of  “How do I make the background green?”

Magento Beginner’s Guide does a great job introducing you to the platform, its features and holds your hand through a whole build.  It could very well be a “For Dummies” book because of the required knowledge needed to get started (essentially that the store owner can turn on a computer and check their email).  All of the content is extremely relevant to the beginner and lays out a great plan of attack for getting a store up and functional.

Chapter 2: Installation

The book begins by giving a good introduction of Magento and its features, then the next chapter is entirely devoted to the installation process.   I would guess that the installation process for Magento is one of the biggest turnoffs for beginner site owners.  They get 10% -50% of the way through the installation, depending on how patient they are and walk away because of the hoops they have to jump through to get it up and running.  The book’s author does a great job highlighting what to look for in a good Magento host, setting up a database, how to properly set permissions (he does a beautiful job explaining the intricacies of permissions and ownership so that any layman can understand) and finalizing the installation.   All the content is valuable however he doesn’t get into the potential problems associated with a Magento install. These issues, which can be attributed to the host, ftp client, etc can quickly turn a step by step tutorial on its head.  Which is why the Installation Problems section of Magento’s forum is so popular.

Chapter 3:  Categories and Attributes

Configuring categories and attributes is an essential aspect of setting up a Magento store, and this chapter does a great job defining the myriad dropdowns, tabs and settings needed to set things up right.   Learning how Magento needs at least on active category under “Default Category” set to “Is Anchor” for the navigation to appear on the frontend is something that is not at all intuitive and in my opinion poorly highlighted in Magento’s official documentation.

Rice does a great job showing step by step how to create new attributes, assign them to an attribute set (another Magento annoyance of mine), and how to structure categories to get the desired result.  A reoccurring feature of the book is the “What Just Happened” notes which appears at the end of each section.  This consistent feature helps recap what’s going on, reinforces the ideas presented throughout the book, and maintains the “For Dummies” element of the book.   If you’re interested in reading this chapter in its entirety, Packt has made it available on their site free to preview.

Chapter 4: Tax Rules

Well you learn something new everyday, and I must say I learned a lot from this chapter.  As a web developer (and as a warm-blooded human being), tax rates, rules and classes sound about as fun as a sidekick to the stomach.  Rice highlights the importance of configuring tax rules properly and setting them up for different customer groups so your store stays legal and flexible.  After all, e-commerce is there to spread your brand’s visibility beyond your hometown (population 380) and onto the national stage (watch out Amazon!).  In order to do this properly, you need to have a great understanding of the intricacies of how taxes are configured for your store.  Learn to hate New York and its per-county rates.  Learn to import an XML sheet to take the pain away from manual data entry (something we did back before Magento 1.1).  Setting up tax rules and classes is another area that Magento Beginner’s Guide covers a whole lot better than Magento’s own site.

Chapter 5: Adding Simple Products

Chapter 5 goes over arguably the most intuitive part of Magento, which is to add a simple product to your store.   In helping many people get off the ground with their own Magento builds, I’ve noticed that they can figure their way around the “Add Product” panel better than mostly anything else in the backend.  With that being said, the book does a great job defining a lot of the form fields, which tabs are absolutely essential to create a new product, and what areas you can simply ignore.   It also lays the groundwork for further product configurations, which is outlined in Chapter 7.

Chapter 6: Minimum Customization of Your Store’s Appearance

Here we go! Finally, the real branding of the website!  If I just installed Magento for the first time the first thing I would do is figure out how to get rid of that stupid dog and chalkboard plaguing every page of my pristine new site.  This is the chapter where logos get swapped, callouts get removed, footer info gets changed, and the rest of it.  And it is in this chapter where the real weakness of this book lies.  I say this because while this book does a fantastic job running through Magento for non-technical people, it really is impossible to do any REAL customization without getting your hands dirty with some XML, template and skin files.  The book gently touches on customizing the XML to change the callouts, but it fails to mention that its how about 85% of things get customized in Magento is by using a Find and Replace tool in a text editor, and not through the admin panel.

A great guy and former Magento novice Brian Lord of Danka Clothing brilliantly described his first experiences with Magento one he was up and running:

I felt like a first grader when I first was messing with it.  Once I got over the hump though it really made a lot of sense.  It took me about 5 minutes before my hands were covered in Magento oil

At the end of the day, Magento is a freaking Russian nesting doll of directories, XML nodes, code snippets and blocks.  However, it is not the role of Magento Beginner’s Guide to cover that level of customization. Doing so would would be akin to teaching organic chemistry to a 2nd grader.  That’s where Magento 1.3 Theme Design comes into play.  Packt’s got you covered!  So thankfully, the main weakness of this book is 100% covered once the reader graduates to the next level of Magento Zen.

Wrap Up

Magento Beginner’s Guide lays a solid foundation for comprehending what is ultimately a very capable yet involved  system.  While the learning curve of Magento is steep, I strongly feel that the effort is worthwhile.  One of Magento’s biggest advantages is its flexibility and everyone who has  taken the time to learn Magento’s structure is extremely pleased with the results. However, you have to start at the beginning like anything in life, and this book does a great job of setting the cornerstone of the Magento Cathedral of Knowledge.  Stay tuned for Part 2 of this review where I’ll review customizable products, payment methods and more!

Yesterday Varien announced Magento Enterprise Edition, which is a commercially-licensed e-commerce platform built on their free open source version.  From Varien’s standpoint, I can understand their need to monetize their product, however I feel this is a big disappointment to the growing Magento development community.  With over to 750,000 downloads in less than a year, Magento’s growth has been quick and has gained a ton of momentum from developers and critics.  What better way to totally reverse that momentum by locking up the best features in a premium version and slapping a huge pricetag on it ($8,900 A YEAR?!).

From a developer’s standpoint, I was really looking forward to a lot of the features that were being hyped up by the team on the roadmap and/or forums (specifically the gift cards).  Now that a lot of beneficial features will be locked up in an expensive premium version, I expect to see that excitement and momentum from the community fade.

I liken Magento Enterprise Edition to Trickle Down Economics.  Varien will argue that developing these new features for the premium version will have a positive impact on the rest of the Magento community.  Those features will essentially trickle down into the free version over time and everyone will benefit from them. But I feel the reality is that as long as Varien is profiting from those advanced features, there’s absolutely no incentive for them to release them to the rest of the community until they’ve made their buck.  Varien will be the gatekeeper and will control the growth of the community.

Despite the “Commitment to Open Source” paragraph in their announcement, the fact remains now they have to split their attention between their community version and their commercial version.  Varien knows that its community is its biggest asset, so why alienate its passionate user base by moonlighting on a premium product?   Their release of a commercial version muddies its relationship with their community.  In forum discussions Magento team members are amazing resources.  Now that they have premium features, can they fully support the community without giving away their premium features/advice/info?  Will community demand for a certain feature result in a feature that will be released to the community version, or will Varien develop it themselves for their premium version?

It will be interesting to see where it goes from here.  How many people will jump on board with Magneto Enterprise Edition? How will the community react?  How will the development of Magento change now that there are multiple versions?

I continue to look forward developing websites using Magento. I think its a fantastic platform with a host of great tools and a ton of potential.  But I can’t help but wonder what would have happened if Mozilla came out with a “premium” version of Firefox when version 2 was released.  Would Firefox 3 be what it is today?  Is Varien stifling the growth of its open source community?