NAV Navbar
code

Introduction

Welcome to the BlogShops API for Theming!

The documentation contained herein defines all of the variables you have access to within your theme's templates.

The theming engine syntax through which you use these variables is based on dwoo. Feel free to check out their documentation for additional syntax available to you.

Templates

Theme templates contain includes and controls files which may vary by theme, but the core files below are part of every theme.

Template Description
blog.tpl The homepage template for your blog. Normally shows abbreviated posts that users can page through.
checkout-bottom.tpl The portion of checkout pages after system-controlled data/forms.
checkout-top.tpl The portion of checkout pages before system-controlled data/forms.
item.tpl The item page template.
landing.tpl The landing page template for your site.
no-results.tpl The template that loads when no results are found.
page.tpl The template that loads to display a page.
shop.tpl The homepage template for your shop. Normally shows items that users can page through and filter.

Syntax

You can use logical operators and variables within your templates. Any template code you create will be enclosed in braces.

{$var}

The code above will simply output the contents of variable named var.

Global Object

True if site logo exists.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnHasProfile

True if owner profile image exists.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnHasSaleItems

True if sale items exist.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnInCategory

True if content is filtered by category.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnPaginate

True if paginate setting is true.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnShowAuthor

True if show author setting is true.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnShowPostDate

Example using $blnShowPostDate:


        {if $global.blnShowPostDate}
            <span class="entry-date">
                <time class="published">{$posts.post_date}</time>
            </span>    
        {/if}
        

True if show post date setting is true.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

blnUseShoppingBag

True if use shopping bag setting is true.

Type

boolean

Summary

Scope Type Returns
Global Object boolean {true, false}

current_category

The current category.

Type

string

Summary

Scope Type
Global Object string

The text to print in the footer, such as a copyright statement.

Type

string

Summary

Scope Type
Global Object string

site_name

The name of the site.

Type

string

Summary

Scope Type
Global Object string

slogan

The site's slogan.

Type

string

Summary

Scope Type
Global Object string

The url for the site's logo.

Type

string

Summary

Scope Type
Global Object string

src_profile

The url source for the site owner's profile image.

Type

string

Summary

Scope Type
Global Object string

url_blog

The url for the blog.

Type

string

Summary

Scope Type
Global Object string

The url for featured items.

Type

string

Summary

Scope Type
Global Object string

url_new_items

The url for new items.

Type

string

Summary

Scope Type
Global Object string

url_sale_items

The url for sale items.

Type

string

Summary

Scope Type
Global Object string

url_shop

The url for the shop.

Type

string

Summary

Scope Type
Global Object string

url_site

The url for the site.

Type

string

Summary

Scope Type
Global Object string

url_theme_images

The url to theme images.

Type

string

Summary

Scope Type
Global Object string

url_uploads

The url for uploads. Should be followed by a filename.

Type

string

Summary

Scope Type
Global Object string

Post Object

arrAttachedItems

Outputing content from $arrAttachedItems:


        {foreach $posts.arrAttachedItems key_attached_items attached_items}
            <li class="product has-post-thumbnail"> 
                {if $attached_items.blnIsSaleItem} 
                    <span class="onsale">Sale!</span> 
                {/if} 
                <div class="loop-product-thumbnail"> 
                    <a class="shop-LoopProduct-link shop-loop-product__link" href="{$attached_items.permalink}"> 
                        <img alt="" class="attachment-shop_thumbnail size-shop_thumbnail" height="300" sizes="(max-width: 300px) 100vw, 300px" src="{$attached_items.item_image_thumbnail}"> 
                    </a> 
                </div> 
                <a class="shop-LoopProduct-link shop-loop-product__link text-center" href="{$attached_items.permalink}"> 
                    <h6 class="shop-loop-product__title text-center">{$attached_items.item_name}</h6>
                    </a> <div class="text-center"> 
                        {if $attached_items.blnIsSaleItem} 
                            <del>
                                <span class="shop-Price-amount amount"> 
                                    {$attached_items.item_price_compare} 
                                </span>     
                            </del> 
                            <ins> 
                                <span class="shop-Price-amount amount"> 
                                    {$attached_items.item_price} 
                                </span> 
                            </ins> 
                        {else} 
                            <span class="shop-Price-amount amount"> 
                                {$attached_items.item_price} 
                            </span> 
                        {/if} 
                    </div> 
                </a> 
            </li>
        {/foreach}
        

Attached items details.

Type

array

Summary

Scope Type Returns
Posts Object array array {permalink, item_name, meta_description, item_image_thumbnail, item_image, item_price, item_price_short, item_price_compare, item_price_compare_short, blnIsSaleItem}

arrSimilarPosts

Similar post details.

Type

array

Summary

Scope Type Returns
Posts Object array array {permalink, post_title, meta_title, meta_description, cover_image, cover_image_thumbnail}

arrTags

Outputing content from $arrTags:


        {foreach $posts.arrTags as tags}
            {* Display HTML *}
            <span class="tags-links">
                <a href="{$tags.permalink}" rel="tag">#{$tags.name}</a>
            </span>
        {/foreach}
        

Post tag details.

Type

array

Summary

Scope Type Returns
Posts Object array array {permalink, name}

author_about

Details about the author.

Type

string

Summary

Scope Type
Posts Object string

author_name

The name of the post's author.

Type

string

Summary

Scope Type
Posts Object string

blnHasAuthor

True if author name exists.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasAuthorImage

True if author has image.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasCover

True if post has cover image.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasItemsAttached

True if the post has an item attached.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasPost

True if post content exists.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasPostCategory

True if post category is assigned.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasPostMetaDescription

True if the post has a meta description.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasPostMetaTitle

True if the post has a meta title.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasPostSubcategory

True if post subcategory is assigned.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnHasTags

True if post has tags.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnPostIsAbbreviated

True if abbreviated post content differs from post content.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

blnPostedThisYear

True if post was made this year.

Type

boolean

Summary

Scope Type Returns
Posts Object boolean {true, false}

The permalink to the post.

Type

string

Summary

Scope Type
Posts Object string

post

The post content.

Type

string

Summary

Scope Type
Posts Object string

post_abbreviated

The abbreviated post content if it it exists; otherwise, the post content.

Type

string

Summary

Scope Type
Posts Object string

post_category

The name of the assigned post category.

Type

string

Summary

Scope Type
Posts Object string

post_date

Formatted date of post. Example: March 7, 2018

Type

string

Summary

Scope Type
Posts Object string

post_day_of_month

Numeric day of month of post. Example: 7

Type

string

Summary

Scope Type
Posts Object string

post_day_of_week

Day of week od post. Example: Wednesday

Type

string

Summary

Scope Type
Posts Object string

post_day_of_week_abbreviated

Day of week of post abbreviated. Example: Wed

Type

string

Summary

Scope Type
Posts Object string

post_meta_description

Contains the post's meta description.

Type

string

Summary

Scope Type
Posts Object string

post_meta_title

Contains the post's meta title.

Type

string

Summary

Scope Type
Posts Object string

post_month

Month of post. Example: March

Type

string

Summary

Scope Type
Posts Object string

post_month_abbreviated

Month of post abbreviated. Example: Mar

Type

string

Summary

Scope Type
Posts Object string

post_month_numeric

Month of post abbreviated. Example: 3

Type

string

Summary

Scope Type
Posts Object string

post_subcategory

The name of the assigned post subcategory.

Type

string

Summary

Scope Type
Posts Object string

post_title

The title of the post.

Type

string

Summary

Scope Type
Posts Object string

post_year

Year of post. Example: 2018

Type

string

Summary

Scope Type
Posts Object string

src_author

The url source for the author's image.

Type

string

Summary

Scope Type
Posts Object string

src_cover

The url source for the post's cover image.

Type

string

Summary

Scope Type
Posts Object string

url_author_posts

The url for other post's by this author.

Type

string

Summary

Scope Type
Posts Object string

url_post_category

The url of the assigned post category.

Type

string

Summary

Scope Type
Posts Object string

url_post_subcategory

The url of the assigned post subcategory.

Type

string

Summary

Scope Type
Posts Object string

Items Object

arrBullets

Outputing content from $arrBullets:


        {foreach $item.arrBullets key_bullets bullets}
            {* Display HTML *}
            <li>
              {$bullets}
            </li>
        {/foreach}
        

Item bullet point details.

Type

array

Summary

Scope Type Returns
Items Object array array {entity}

arrItemDetails

The item detail section data.

Type

array

Summary

Scope Type Returns
Items Object array array {label, details)

arrItemImageThumbnails

Outputing content from $arrItemImageThumbnails:


            {foreach $item.arrItemImageThumbnails key_item_thumbnails item_thumbnails}
                <li>
                    <img class="item-gallery-thumbnail" draggable="false" src="{$item_thumbnails}">
                </li>
            {/foreach}
        

Item image thumbnail url sources.

Type

array

Summary

Scope Type Returns
Items Object array array {}

arrItemImages

Item image url sources.

Type

array

Summary

Scope Type Returns
Items Object array array {}

arrRelatedItems

Outputing content from $arrRelatedItems:


        {foreach $item.arrRelatedItems key_related_items related_items}
            <li class="product type-product status-publish has-post-thumbnail post first product-type-simple"> 
                {if $related_items.blnIsSaleItem} 
                    <span class="onsale">Sale!</span> 
                {/if} 
                <div class="loop-product-thumbnail"> 
                    <a class="shop-LoopProduct-link shop-loop-product__link" href="{$related_items.permalink}">
                        <img alt="" class="attachment-shop_thumbnail size-shop_thumbnail wp-post-image" height="300" sizes="(max-width: 300px) 100vw, 300px" src="{$related_items.item_image_thumbnail}"
                    </a> 
                </div>
                <a class="shop-LoopProduct-link shop-loop-product__link" href="{$related_items.permalink}"> 
                    <h2 class="shop-loop-product__title">{$related_items.item_name}</h2>
                </a> 
                <span class="price"> 
                    {if $related_items.blnIsSaleItem} 
                        <del>
                            <span class="shop-Price-amount amount"> 
                                {$related_items.item_price_compare} 
                            </span>
                        </del> 
                        <ins> 
                            <span class="shop-Price-amount amount"> 
                                {$related_items.item_price} 
                            </span> 
                        </ins> 
                    {else} 
                        <span class="shop-Price-amount amount"> 
                            {$related_items.item_price} 
                        </span> 
                    {/if} 
                </span> 
            </li>            
        {/foreach}
        

The related items assigned to this item.

Type

array

Summary

Scope Type Returns
Items Object array array {permalink, item_name, meta_description, item_image_thumbnail, item_image, item_price, item_price_short, item_price_compare, item_price_compare_short, blnIsSaleItem}

arrSimilarItems

Similar items picked by system for this item.

Type

array

Summary

Scope Type Returns
Items Object array array {permalink, item_name, meta_description, item_image_thumbnail, item_image, item_price, item_price_short, item_price_compare, item_price_compare_short, blnIsSaleItem}

blnHasBullets

True if the item has bullet points.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemCategory

True if item has a category.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemDescription

True if the item has item description.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemDescriptionPreview

True if the item has item description preview.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage

True if default item image exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage2

True if item image #2 exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage3

True if item image #3 exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage4

True if item image #4 exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage5

True if item image #5 exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage6

True if item image #6 exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemImage7

True if item image #7 exists.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemMetaDescription

True if the item has a meta description.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasItemSubcategory

True if item has a subcategory.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasPriceRange

True if the item's price is a range.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasRelatedItems

Outputing content from $arrRelatedItems:


        {foreach $item.arrRelatedItems key_related_items related_items}
            <li class="product type-product status-publish has-post-thumbnail post first product-type-simple"> 
                {if $related_items.blnIsSaleItem} 
                    <span class="onsale">Sale!</span> 
                {/if} 
                <div class="loop-product-thumbnail"> 
                    <a class="shop-LoopProduct-link shop-loop-product__link" href="{$related_items.permalink}">
                        <img alt="" class="attachment-shop_thumbnail size-shop_thumbnail wp-post-image" height="300" sizes="(max-width: 300px) 100vw, 300px" src="{$related_items.item_image_thumbnail}"
                    </a> 
                </div>
                <a class="shop-LoopProduct-link shop-loop-product__link" href="{$related_items.permalink}"> 
                    <h2 class="shop-loop-product__title">{$related_items.item_name}</h2>
                </a> 
                <span class="price"> 
                    {if $related_items.blnIsSaleItem} 
                        <del>
                            <span class="shop-Price-amount amount"> 
                                {$related_items.item_price_compare} 
                            </span>
                        </del> 
                        <ins> 
                            <span class="shop-Price-amount amount"> 
                                {$related_items.item_price} 
                            </span> 
                        </ins> 
                    {else} 
                        <span class="shop-Price-amount amount"> 
                            {$related_items.item_price} 
                        </span> 
                    {/if} 
                </span> 
            </li>            
        {/foreach}
        

True if item has related items assigned to it.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnHasSimilarItems

True if item has similar items.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnInSort

Example using $blnInSort:


            {if $global.blnInSort}
                Sorted: {$global.current_sort}
            {/if}
        

True if viewing a sorted set of records.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnIsSaleItem

True if the item is on sale.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnItemHasOption1

True if item has an option 1.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

blnItemHasOption2

True if item has an option 2.

Type

boolean

Summary

Scope Type Returns
Items Object boolean {true, false}

current_sort

The description of the current sort.

Type

string

Summary

Scope Type
Items Object string

href_sort_items_new

The href to sort items newest first.

Type

string

Summary

Scope Type
Items Object string

The href to sort popular items first.

Type

string

Summary

Scope Type
Items Object string

href_sort_items_price_high

The href to sort items by price, high to low.

Type

string

Summary

Scope Type
Items Object string

href_sort_items_price_low

The href to sort items by price, low to high.

Type

string

Summary

Scope Type
Items Object string

item_add_cart_button

HTML add to cart button.

Type

string

Summary

Scope Type
Items Object string

item_category

The name of the item category.

Type

string

Summary

Scope Type
Items Object string

item_description

The item description. Only available on item page.

Type

string

Summary

Scope Type
Items Object string

item_description_abbreviated

The abbreviated item description.

Type

string

Summary

Scope Type
Items Object string

item_description_preview

The item description preview, capped at 500 characters.

Type

string

Summary

Scope Type
Items Object string

item_meta_description

The item's meta description.

Type

string

Summary

Scope Type
Items Object string

item_name

The name of the item.

Type

string

Summary

Scope Type
Items Object string

item_price

The item's price or price range.

Type

string

Summary

Scope Type
Items Object string

item_price_compare

The comparison item price.

Type

string

Summary

Scope Type
Items Object string

item_price_compare_short

The comparison item price with decimal portion removed when decimal is zero.

Type

string

Summary

Scope Type
Items Object string

item_price_short

The item's price or price range with decimal portion removed when decimal is zero.

Type

string

Summary

Scope Type
Items Object string

item_subcategory

The name of the item subcategory.

Type

string

Summary

Scope Type
Items Object string

select_option1

HTML select options for option 1.

Type

string

Summary

Scope Type
Items Object string

select_option2

HTML select options for option 2.

Type

string

Summary

Scope Type
Items Object string

src_item_image

The url source for the default item image.

Type

string

Summary

Scope Type
Items Object string

src_item_image2

The url source for item image #2.

Type

string

Summary

Scope Type
Items Object string

src_item_image2_thumbnail

The url source for item image #2 thumbnail.

Type

string

Summary

Scope Type
Items Object string

src_item_image3

The url source for item image #3.

Type

string

Summary

Scope Type
Items Object string

src_item_image3_thumbnail

The url source for item image #3 thumbnail.

Type

string

Summary

Scope Type
Items Object string

src_item_image4

The url source for item image #4.

Type

string

Summary

Scope Type
Items Object string

src_item_image4_thumbnail

The url source for item image #4 thumbnail.

Type

string

Summary

Scope Type
Items Object string

src_item_image5

The url source for item image #5.

Type

string

Summary

Scope Type
Items Object string

src_item_image5_thumbnail

The url source for item image #5 thumbnail.

Type

string

Summary

Scope Type
Items Object string

src_item_image6

The url source for item image #6.

Type

string

Summary

Scope Type
Items Object string

src_item_image6_thumbnail

The url source for item image #6 thumbnail.

Type

string

Summary

Scope Type
Items Object string

src_item_image7

The url source for item image #7.

Type

string

Summary

Scope Type
Items Object string

src_item_image7_thumbnail

The url source for item image #7 thumbnail.

Type

string

Summary

Scope Type
Items Object string

src_item_image_thumbnail

The url source for the default item image thumbnail.

Type

string

Summary

Scope Type
Items Object string

url_item

The url of the item.

Type

string

Summary

Scope Type
Items Object string

url_item_category

The url of the item category.

Type

string

Summary

Scope Type
Items Object string

url_item_subcategory

The url of the item subcategory.

Type

string

Summary

Scope Type
Items Object string

DataSets Object

arrFeaturedItems

Details for featured items.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, item_name, meta_description, item_image_thumbnail, item_image, item_price, item_price_short, item_price_compare, item_price_compare_short, blnIsSaleItem}

arrFeaturedPosts

Details for featured posts.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, post_title, meta_title, meta_description, cover_image, cover_image_thumbnail}

arrItemCategories

Contains item categories.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, category_name}

arrItemSubcategories

Contains item categories.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, subcategory_name}

arrPages

Outputing content from $arrPages:


        {foreach $global.arrPages key_pages pages}
            {* Display HTML *}
            <li> 
                <a href="{$pages.permalink}">{$pages.page_title}</a> 
            </li>
        {/foreach}
        

Details for site pages.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, post_title, meta_title, meta_description, cover_image, cover_image_thumbnail}

arrPostCategories

Example using $blnHasPostCategories, outputing content from $arrPostCategories:


        {if $global.blnHasPostCategories}
            <aside class="widget" id="">
                <ul>
                    {foreach $global.arrPostCategories key_post_categories post_categories}
                        <li> 
                            <a href="{$post_categories.permalink}">{$post_categories.category_name}</a> 
                        </li>
                    {/foreach}    
                </ul>
            </aside>
        {/if}
        

Contains post categories.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, category_name}

arrPostSubcategories

Contains post categories.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, subcategory_name}

arrRecentItems

Details for recent items.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, item_name, meta_description, item_image_thumbnail, item_image, item_price, item_price_short, item_price_compare, item_price_compare_short, blnIsSaleItem}

arrRecentPosts

Details for recent posts.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, post_title, meta_title, meta_description, cover_image, cover_image_thumbnail}

arrSlides

Details for content flagged for slides.

Type

array

Summary

Scope Type Returns
DataSets Object array array {permalink, title, description, image}

blnHasFeaturedItems

True if featured items exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasFeaturedPosts

True if featured posts exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasItemCategories

True if item categories exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasItemSubcategories

True if item subcategories exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasPages

True if site pages exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasPostCategories

Example using $blnHasPostCategories, outputing content from $arrPostCategories:


        {if $global.blnHasPostCategories}
            <aside class="widget" id="">
                <ul>
                    {foreach $global.arrPostCategories key_post_categories post_categories}
                        <li> 
                            <a href="{$post_categories.permalink}">{$post_categories.category_name}</a> 
                        </li>
                    {/foreach}    
                </ul>
            </aside>
        {/if}
        

True if post categories exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasPostSubcategories

True if post subcategories exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasRecentItems

True if recent items exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasRecentPosts

True if recent posts exist.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

blnHasSlides

True if slide content exists.

Type

boolean

Summary

Scope Type Returns
DataSets Object boolean {true, false}

Navigation Object

Example using $authentication_state and $url_authentication:


            <li class="menu-item">
                <a href="{$global.url_authentication}" style="width: 101px;">{$global.authentication_state}</a>         
            </li>
        

Displays authentication state. Can be Sign In or Sign Out.

Type

string

Summary

Scope Type
Navigation Object string

True if user is signed in.

Type

boolean

Summary

Scope Type Returns
Navigation Object boolean {true, false}

The cart icon.

Type

string

Summary

Scope Type
Navigation Object string

The CSS class required for a shopping cart link.

Type

string

Summary

Scope Type
Navigation Object string

The href to open the shopping cart modal.

Type

string

Summary

Scope Type
Navigation Object string

The href to open the search modal.

Type

string

Summary

Scope Type
Navigation Object string

Summarized location on site. Can be landing, blog, page, shop, or checkout.

Type

string

Summary

Scope Type
Navigation Object string

Example using $authentication_state and $url_authentication:


            <li class="menu-item">
                <a href="{$global.url_authentication}" style="width: 101px;">{$global.authentication_state}</a>         
            </li>
        

The url to sign in or sign out based on authentication state.

Type

string

Summary

Scope Type
Navigation Object string

The url to sign in.

Type

string

Summary

Scope Type
Navigation Object string

The url to sign out.

Type

string

Summary

Scope Type
Navigation Object string

Social Object

blnHasFacebook

Example using $blnHasFacebook and $url_facebook:


            {if $global.blnHasFacebook}
                <li>
                    <a target="_BLANK" href="{$global.url_facebook}">Facebook</a>
                </li>
            {/if}
        

True if Facebook page exists.

Type

boolean

Summary

Scope Type Returns
Social Object boolean {true, false}

blnHasGooglePlus

True if Google+ page exists.

Type

boolean

Summary

Scope Type Returns
Social Object boolean {true, false}

blnHasInstagram

True if Instagram page exists.

Type

boolean

Summary

Scope Type Returns
Social Object boolean {true, false}

blnHasTwitter

True if Twitter page exists.

Type

boolean

Summary

Scope Type Returns
Social Object boolean {true, false}

url_facebook

Example using $blnHasFacebook and $url_facebook:


            {if $global.blnHasFacebook}
                <li>
                    <a target="_BLANK" href="{$global.url_facebook}">Facebook</a>
                </li>
            {/if}
        

The url for the Facebook page.

Type

string

Summary

Scope Type
Social Object string

url_google_plus

The url for the Google+ page.

Type

string

Summary

Scope Type
Social Object string

url_instagram

The url for the Instagram page.

Type

string

Summary

Scope Type
Social Object string

url_twitter

The url for the Twitter page.

Type

string

Summary

Scope Type
Social Object string