View source for Liquid Template Variables - collection

The Liquid template variable '''collection''' has the following attributes:

== <code>collection.id</code> ==

Returns the unique internal number of the collection.

This is normally only for internal usage.

== <code>collection.handle</code> ==

This is the collection handle. The handle uniquely identifies the collection in the URL address.

The handle is usually the collection's title in lower case with all blanks replaced by a dash. "Summer Sale" would have the handle "summer-sale".

== <code>collection.title</code> ==

Returns the title of this collection.

== <code>collection.description</code> ==

Returns the description of this collection.

== <code>collection.content</code> ==

This is an alias of description.

== <code>collection.products</code> ==

Returns a collection of all [[Liquid_Template_Variables_-_product|products]] that are associated with this ''collection'', matching the current view. The current view is takes into account things like pagination and selected tags. You can access each product using a ''for'' iteration.

<pre>{% for product in collection.products %}
   {{ product.title }}
{% endfor %}</pre>

'''Warning''': A maximum of 50 products are returned unless pagination is being used.

== <code>collection.products_count</code> ==

Returns the number of products in the collection.

== <code>collection.all_products</code> ==

Returns a collection of all [[Liquid_Template_Variables_-_product|products]] that are associated with this ''collection''.

'''Warning''': A maximum of 50 products are returned unless pagination is being used.

== <code>collection.all_products_count</code> ==

Returns the number of all products in the collection.

== <code>collection.published</code> ==

Return ''true'' if the collection is published. Otherwise return ''false''.

== <code>collection.tags</code> ==

Returns all of the tags associated with all of the products in this particular collection which match the current view. This means that if the current view is filtered to only contain products with a certain tags, then this call will return all of the tags that the remaining products actually have.

<pre><ul>
  {% for tag in tags %}
  <li>{{ '+' | link_to_add_tag: tag }} {{ tag | link_to_tag: tag }}</li>
  {% endfor %}
</ul></pre>

== <code>collection.all_tags</code> ==

Returns all tags associated with the collection.

== <code>collection.tagged</code> ==

Returns the tags used to tag this collection when it was created.

For example, if a collection is viewed using the optional tags in the URL, then the tags can be retrieved using this method.

<pre>
/collections/home-page/green => ['green']
</pre>

== <code>collection.image</code> ==

Returns the first collection image as an [[Liquid_Template_Variables_-_image|image]] template variable.

When used directly, such as ''collection.image'', it returns the relative URL path of the collection image. This is equivalent to using ''collection.image.src''.

For example,

<pre>
<div>
  <img src="{{ collection.image | collection_img_url: 'medium' }}" alt="{{ collection.image.alt | escape }}" />
</div>
</pre>

== <code>collection.featured_image</code> ==

Returns the first collection image as an [[Liquid_Template_Variables_-_image|image]] template variable.

When used directly, such as ''collection.featured_image'', it returns the relative URL path of the collection image. This is equivalent to using ''collection.featured_image.src''.

For example,

<pre>
<div>
  <img src="{{ collection.featured_image | collection_img_url: 'medium' }}" alt="{{ collection.featured_image.alt | escape }}" />
</div>
</pre>

This method is functionally equivalent to <code>collection.image</code>.

== <code>collection.images</code> ==

Returns an array of all the [[Liquid_Template_Variables_-_image|image]] template variables for this collection.

For example,

<pre>
{% for image in collection.images %}
  {{ image | collection_img_url: 'medium' }}
{% endfor %}
</pre>

When used directly, such as ''image'', it returns the relative URL path of the image. This is equivalent to using ''image.src''.

== <code>collection.images_count</code> ==

Returns the number of images for this collection.

== <code>collection.image_type</code> ==

Returns the type of images, in this case <code>'Collection'</code>.

== <code>collection.next_product</code> ==

Returns the next product in the collection, when your product pages have been scoped to a certain collection.

For a discussion of this, read [[How To Navigate Within A Collection]].

== <code>collection.previous_product</code> ==

Returns the previous product in the collection, when your product pages have been scoped to a certain collection.

For a discussion of this, read [[How To Navigate Within A Collection]].

== <code>collection.url</code> ==

The is the relative URL address of the collection.

<pre>
/collections/nicknacks
</pre>

If the collection was tagged, then the tags are returned as well.

<pre>
/collections/nicknacks/red+blue
</pre>

== <code>collection.all_types</code> ==

Returns a list of all unique product types in the collection. An array of [[ Liquid Template Variables - type | type]]s is returned.

Example usage:

<pre>
<ul>
{% for product_type in collection.all_types %}
  <li>
    {{ product_type | link_to_type }}
  </li>
{% endfor %}
</ul>
</pre>

== <code>collection.all_vendors</code> ==

Returns a list of all unique product vendors in the collection. An array of [[ Liquid Template Variables - vendor | vendor]]s is returned.

Example usage:

<pre>
<ul>
{% for product_vendor in collection.all_vendors %}
  <li>
    {{ product_vendor | link_to_vendor }}
  </li>
{% endfor %}
</ul>
</pre>

== <code>collection.default_sort_by</code> ==

Returns the default sort order of the collection. This value is set for the collection on the collection page of the Toolbox.

The following values can be returned:

<pre>
default
featured
best-selling
title-ascending
title-descending
created-ascending
created-descending
updated-ascending
updated-descending
price-ascending
price-descending
random
</pre>

== <code>collection.sort_by</code> ==

If the collection has had its default sorting order overriden, then the new sorting order is returned.

== <code>collection.metafields</code> ==

Return the [[Liquid Template Variables - metafields|metafields]] for the collection.

Metafields can only be managed using the Spiffy Stores API.

== Further Reference ==

* [[Liquid Basics]]
* [[Liquid Tag Reference]]
* [[Liquid Filter Reference]]
* [[Liquid Variable Reference]]
* [[Liquid Paginate Tag|Pagination ]]