Liquid Template Variables - collection
From Spiffy Stores Knowledge Base
The Liquid template variable collection has the following attributes:
Contents
- 1 collection.id
- 2 collection.handle
- 3 collection.title
- 4 collection.description
- 5 collection.content
- 6 collection.products
- 7 collection.products_count
- 8 collection.all_products
- 9 collection.all_products_count
- 10 collection.published
- 11 collection.tags
- 12 collection.all_tags
- 13 collection.tagged
- 14 collection.image
- 15 collection.featured_image
- 16 collection.images
- 17 collection.images_count
- 18 collection.image_type
- 19 collection.next_product
- 20 collection.previous_product
- 21 collection.url
- 22 collection.all_types
- 23 collection.all_vendors
- 24 collection.default_sort_by
- 25 collection.sort_by
- 26 collection.metafields
- 27 Further Reference
collection.id
Returns the unique internal number of the collection.
This is normally only for internal usage.
collection.handle
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".
collection.title
Returns the title of this collection.
collection.description
Returns the description of this collection.
collection.content
This is an alias of description.
collection.products
Returns a collection of all 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.
{% for product in collection.products %}
{{ product.title }}
{% endfor %}
Warning: A maximum of 50 products are returned unless pagination is being used.
collection.products_count
Returns the number of products in the collection.
collection.all_products
Returns a collection of all products that are associated with this collection.
Warning: A maximum of 50 products are returned unless pagination is being used.
collection.all_products_count
Returns the number of all products in the collection.
collection.published
Return true if the collection is published. Otherwise return false.
collection.tags
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.
<ul>
{% for tag in tags %}
<li>{{ '+' | link_to_add_tag: tag }} {{ tag | link_to_tag: tag }}</li>
{% endfor %}
</ul>
collection.all_tags
Returns all tags associated with the collection.
collection.tagged
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.
/collections/home-page/green => ['green']
collection.image
Returns the first collection image as an 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,
<div>
<img src="{{ collection.image | collection_img_url: 'medium' }}" alt="{{ collection.image.alt | escape }}" />
</div>
collection.featured_image
Returns the first collection image as an 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,
<div>
<img src="{{ collection.featured_image | collection_img_url: 'medium' }}" alt="{{ collection.featured_image.alt | escape }}" />
</div>
This method is functionally equivalent to collection.image.
collection.images
Returns an array of all the image template variables for this collection.
For example,
{% for image in collection.images %}
{{ image | collection_img_url: 'medium' }}
{% endfor %}
When used directly, such as image, it returns the relative URL path of the image. This is equivalent to using image.src.
collection.images_count
Returns the number of images for this collection.
collection.image_type
Returns the type of images, in this case 'Collection'.
collection.next_product
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.
collection.previous_product
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.
collection.url
The is the relative URL address of the collection.
/collections/nicknacks
If the collection was tagged, then the tags are returned as well.
/collections/nicknacks/red+blue
collection.all_types
Returns a list of all unique product types in the collection. An array of types is returned.
Example usage:
<ul>
{% for product_type in collection.all_types %}
<li>
{{ product_type | link_to_type }}
</li>
{% endfor %}
</ul>
collection.all_vendors
Returns a list of all unique product vendors in the collection. An array of vendors is returned.
Example usage:
<ul>
{% for product_vendor in collection.all_vendors %}
<li>
{{ product_vendor | link_to_vendor }}
</li>
{% endfor %}
</ul>
collection.default_sort_by
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:
default featured title-ascending title-descending created-ascending created-descending updated-ascending updated-descending price-ascending price-descending random
collection.sort_by
If the collection has had its default sorting order overriden, then the new sorting order is returned.
collection.metafields
Return the metafields for the collection.
Metafields can only be managed using the Spiffy Stores API.