Blog
{{ blog }}
| Name |
Type |
Description |
| object_type |
String |
Will always be datastore_item |
| is_valid |
Boolean |
True if this references a published blog |
| guid |
String |
The unique identifier for this blog |
| value |
String |
Synonymn for guid |
| name |
text |
The name of the blog |
| title |
text |
The title of the blog |
| linked_title |
String |
A link to the blog if it has a URL, or the escaped title if not |
| has_url |
Boolean |
True if the blog has a URL |
| include_in_search |
Boolean |
Whether or not this blog should be returned in on-site search results |
| domain_name |
text |
The domain name used by the URL for this blog |
| url |
text |
The portion of the URL for this blog following the domain name |
| full_url |
String |
The full URL for this blog including the scheme, domain name, and path |
| visited |
Boolean |
Whether or not the user has visited this URL previously in their current session. Note that this will always be false if the user has not allowed session permission (see the Permissions and Personalization documentation). Using this property prevents the page from being fast-cached |
| template_guid |
String |
The unique identifier for the template that would be used to respond to this URL |
| template |
template |
The template that would be used to respond to this URL |
| canonical_url |
url |
The canonical URL if this is not the original source of content for this URL |
| browser_title |
text |
The browser title to use for this URL |
| meta_description |
textarea |
The meta description for this URL |
| meta_robots |
text |
The meta robots for this URL |
| keywords |
textarea |
The SEO keywords for this URL |
| search_entity_guid |
String |
The unique identifier for the entity that search results should be directed to (if this blog does not have a URL) |
| search_entity |
entity |
The entity that search results should be directed to (if this blog does not have a URL) |
| folder_guid |
String |
The unique identifier for the folder that contains this blog. |
| folder |
folder |
The folder that contains this blog. |
| field_id |
String |
The identifier for this field |
| label |
String |
The label for this field |
| output |
String |
The default output that the blog produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of blogs themselves |
| data |
data |
Object containing the custom fields on this blog |
| * |
String |
Specific custom fields may be accessed using {{ entity.fieldid }} or {{blog['field-id']}} |
{{ blogs }}
Contains multiple blogs.
| Name |
Type |
Description |
| output |
String |
The default output that the blogs will produce when it is output directly to the template - using the "output_in_list" property of each blog in the items list |
{% blog %}
var|set|assign
Optional. Specify either "var", "set" or "assign" to change which scope this
blog is stored on. "var" is the default behavior.
variable_name
Specify a variable name in order to save this
blog to a variable. If not specified, it will be output to the template instead.
output_to_template
If included the
blog will be output directly to the template.
{% blogs %}
var|set|assign
Optional. Specify either "var", "set" or "assign" to change which scope this
blogs is stored on. "var" is the default behavior.
variable_name
Specify a variable name in order to save this
blogs to a variable. If not specified, it will be output to the template instead.
output_to_template
If included the
blogs will be output directly to the template.
prepend:value
Prepend the specified blogs before the fetched results. All prepended input will be returned in the same order that it is input. Value may one or more blogs, a guid, or a string.
append:value
Append the specified blogs after the fetched results. All appended input will be returned in the same order that it is input. Value may one or more blogs, a guid, or a string.
exclude:value
Prevent the specified blogs from being included in the fetched results. Has no affect on prepended and appended items. Value may one or more blogs, a guid, or a string.
exclude_prepended:true
Specifically exclude all prepended blogs from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended:true
Specifically exclude all appended blogs from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique:true
If set to true, each of the resulting lists (prepended, fetched, appended, and items) will be unique, although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size:number
If specified, then the "items" list will only include up to the specified number of blogs. The "limit" may be automatically lowered to only fetch the maximum number of articles that will be included in "items" following prepended items. Note that this may also impact both the "page" and "total_pages" values. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
Examples
Use the group_by filter to group objects by a specific property. For example, you can group a list of blog posts by blog.
{% blog_posts posts = limit: 40 start: 1 sort_by: 'date_posted' sort_direction: 'desc' %}
{% var grouped_by_blog = posts | group_by: 'blog' %}
{% for group in grouped_by_blog %}
{{ group.Key.title }}: {{ group.Value | size }}
{% endfor %}
{% assign var postsPerPage = 10 %}
{% assign pageParam = 1 %}
{% if request.query_params['page'] %}
{% assign pageParam = request.query_params['page'] | to_int %}
{% endif %}
{% if request.query_params['tag'] and request.query_params['tag'] != "" %}
{% assign tagFilter = request.query_params['tag'] | url_decode | downcase %}
{% endif %}
{% blog_posts assign posts = blog:"The Kitchen Essentials" tag:tagFilter limit:postsPerPage page:pageParam sort_by:"post_date" sort_direction:"desc" %}
{% for post in posts %}
{{post.title}}
{% endfor %}
{% search output_to_template request.query_params.q type:blog_post %}
Use the random filter to get a random blog post from a list of blog posts.
{% blog_posts posts = start:1 limit:10 %}
{% var randompost = posts | rand %}
Use the rand filter to get 3 random blog posts from a list of blog posts. Do not allow duplicates.
{% blog_posts posts = start:1 limit:10 %}
{% var randomposts = posts | rand:3, false %}
Use the map filter to map blog posts to their linked title. The map filter could just as easily be used for any other property as well.
{% blog_posts posts = limit: 10 sort_by 'post_date' sort_direction:'desc' %}
{{ posts | map: 'linked_title' | join: '
' }}