Blog Post

Name	Type	Description
object_type	String	Will always be datastore_item
is_valid	Boolean	True if this references a published blog_post
guid	String	The unique identifier for this blog_post
value	String	Synonymn for guid
name	text	The name of the blog_post
title	text	The title of the blog_post
linked_title	String	A link to the blog_post if it has a URL, or the escaped title if not
blog_guid	String	The unique identifier of the related blog
blog	blog	Reference to the related blog object
image_guid	String	The unique identifier of the related image
image	image	Reference to the related image object
summary_html	html	Short HTML summary used in list views
content_html	html	The primary HTML content for the blog post
post_date	datetime	The primary date associated with this blog post - typically the date that it was originally written or posted and set by the content editor
tags	tags	The list of tags associated with this blog_post
authors	authors	The list of authors associated with this blog_post
has_url	Boolean	True if the blog_post has a URL
include_in_search	Boolean	Whether or not this blog_post should be returned in on-site search results
domain_name	text	The domain name used by the URL for this blog_post
url	text	The portion of the URL for this blog_post following the domain name
full_url	String	The full URL for this blog_post 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_post does not have a URL)
search_entity	entity	The entity that search results should be directed to (if this blog_post does not have a URL)
folder_guid	String	The unique identifier for the folder that contains this blog_post.
folder	folder	The folder that contains this blog_post.
field_id	String	The identifier for this field
label	String	The label for this field
output	String	The default output that the blog_post 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 blog posts themselves
data	data	Object containing the custom fields on this blog_post
*	String	Specific custom fields may be accessed using {{ entity.fieldid }} or {{blog_post['field-id']}}

Contains multiple blog_posts.

Name	Type	Description
object_type	String	Will always be datastore_item
is_valid	Boolean	True if this contains at least one published blog_post
output	String	The default output that the blog_posts will produce when it is output directly to the template - using the "output_in_list" property of each blog_post in the items list
prepended	list	List containing any prepended blog_posts.
fetched	list	List containing all of the blog_posts that were fetched from the database (as opposed to prepended or appended).
appended	list	List containing any appended blog_posts.
appended_unique	list	List containing any appended blog_posts excluding any blog_posts that are in either the list of prepended or fetched blog_posts.
items	list	List containing all of the combined blog_posts from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of blog_posts specified.
size	Integer	The total number of blog_posts in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size	Integer	If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this blog_posts object is enumerated as a list. When not set, this value will be 0.
unique	Boolean	When true, the items list will not contain any duplicates. Only the first instance of each blog_post will be included.
limit	Integer	The maximum number of items that were allowed to be in the list of fetched blog_posts. May be 0 in some cases (such as when when there are no fetched blog_posts.
start	Integer	The 1-based index of the first item in the list of fetched blog_posts.
page	Integer	The 1-based index of the paginated results returned in the list of fetched blog_posts, which is calculated from the start and limit parameters. Useful for paginated results.
total_count	Integer	The 1-based index of the first item in the list of fetched blog_posts
total_pages	Integer

{% blog_post %}

{% blog_post output_to_template? [var, set, or assign]? variable? output_to_template? = value %}

{% blog_post

output_to_template

If included the blog_post will be output directly to the template.

var, set, or assign

Optional. Specify either "var", "set" or "assign" to change which scope this blog_post is stored on. "var" is the default behavior.

variable_name

Specify a variable name in order to save this blog_post to a variable. If not specified, it will be output to the template instead.

output_to_template

If included the blog_post will be output directly to the template.

value

Should evaluate to a blog_post object, or the name or guid of a blog_post May use liquid filters.

Fetches a single blog_post.

{% blog_posts %}

{% blog_posts output_to_template? [var, set, or assign]? variable? output_to_template? = arguments %}

{% blog_posts

output_to_template

If included the blog_posts will be output directly to the template.

var, set, or assign

Optional. Specify either "var", "set" or "assign" to change which scope this blog_posts is stored on. "var" is the default behavior.

variable

output_to_template

If included the blog_posts will be output directly to the template.

arguments

Key:value pairs. May use the variable arguments syntax.

arguments

prepend

May be a single blog_post, a list of blog_posts, or the name or guid of a blog_post to be be included at the beginning of the blog_posts.

append

May be a single blog_post, a list of blog_posts, or the name or guid of a blog_post to be be included at the end of the blog_posts.

exclude

May be a single blog_post, a list of blog_posts, or the name or guid of a blog_post that should NOT be included in the fetched results. Has no affect on prepended or appended blog_posts.

exclude_prepended

True to specifically exclude all prepended blog_posts 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 to specifically exclude all appended blog_posts 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 to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), 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

The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many blog_posts as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting blog_posts. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".

filter

Only include blog posts that match the given string filter

blog

May include multiple blogs. Only include blog posts with one of the given blogs

start_date

Only include blog posts with a post_date greater than or equal to start_date

end_date

Only include blog posts with a post_date less than or equal to end_date

tag

May include multiple tags. Only include blog posts with one of the given tags

author

May include multiple authors. Only include blog posts with one of the given authors

folder

May include multiple folders. Only include blog posts with one of the given folders

date_created_start

Only include blog posts with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the blog post was first published.

date_created_end

Only include blog posts with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the blog post was first published.

start

Set the 1-based index of the first blog_post to fetch.

page

Used to automatically calculate the first blog_post to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.

limit

The maximum number of blog_posts to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.

sort_by

Specify which property to sort the results by. Has no affect on prepended or appended blog_posts. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:

relevance: only applies when there is a filter string. When sorting by relevance sort_direction is ignored.
date_created: the date each blog_posts was first published. Unpublishing and republishing a blog_posts resets date_created to the current date.
random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
name
title
url
browser_title

sort_direction

asc or desc.

cache_random

True to allow the results to be cached when sort_by is "random".

Fetches a list of blog_posts.

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 %}
<p>{{ group.Key.title }}: {{ group.Value | size }}</p>
{% 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: '<br />' }}

Blog Post

Blog Post

{{ blog_post }}

{{ blog_posts }}

{% blog_post %}

{% blog_posts %}

Examples