devot:eeDevoted to ExpressionEngine

Stash allows you to stash text and snippets of code for reuse throughout your templates.

Variables can be set dynamically from the GET or POST superglobals and can optionally be cached in the database for persistence across pages. You can even create snippets dynamically, and these will work just like EE’s snippets.

Variables that you create are available to templates embedded below the level at which you are using the tag, or later in the parse order of the current template.

As well as saving strings, Stash lets you create lists of variables (multidimensional arrays) and apply custom sorting/ordering and limits when retrieving them. Very handy for reusing Playa and Matrix row data.

You can also group individual variables into a ‘bundle’ for efficient saving and retrieval, which can be useful when working with form data.

By allowing you to re-use the rendered output of other tags, Stash allows you to respect the DRY principle and create highly efficient templates using the template partials concept. It also provides a convenient way to use pagination when using dynamic parameters.

For an excellent example of working with template partials see the second link below.

Simple example:

{exp:channel:entries limit="1" disable="member_data|pagination|categories"} 
    {exp:stash:set name="title"}{title}{/exp:stash:set}
{/exp:channel:entries}

{!--Now you can access like this in an embedded template or later in the parse order of the same template:--}
{exp:stash:get name="title"}

Pagination example:

{exp:stash:get name="my_form_field_name" type="snippet" dynamic="yes" cache="yes" refresh="30"}

In an embedded template we have a {exp:channel:entries} tag producing a paginated listing of entries:
{exp:channel:entries search:custom_field="{my_form_field_name}" disable="member_data|pagination|categories"}
    ...
{/exp:channel:entries}

Caching example

{exp:stash:set
    name="my_cached_blog_entries"
    save="yes"
    scope="site"
    parse_tags="yes"
    replace="no"
    refresh="60"
    output="yes"
}
    {exp:channel:entries channel="blog"}
        {title}
    {/exp:channel:entries}
{/exp:stash:set}

Download Stash

Stash Links

• Documentation
• Working with files
• Template partials concept

This entry was last updated February 2, 2012, 12:51 am.

Disclaimer: Information about ExpressionEngine add-ons is provided as a service to you, the user, and every member of the ExpressionEngine community. Devot:ee is not responsible if you hose, mangle, wreck, or otherwise destroy your EE website by installing an add-on that you found out about at this site, regardless of its rating, Favorites status, commercial or free status, or general popularity. Caveat EEmptor!