Tags

Tags are Antlers expressions giving you the ability to fetch, filter, and display content, enhance and simplify your markup, build forms, and build dynamic functionality.

Type Description
404 (Not Found)

Triggers a 404 response

Asset

Retrieves an Asset by its URL

Assets

Fetches Assets from a container

Cache

Caches a view chunk for performance gains

Children

Fetch data from children of the current URL

Collection

Fetches and filters entries in one or more collections.

Collection:Count

Fetches the number of entries in a collection

Collection:Next

Fetches the next entries in order.

Collection:Previous

Fetches the previous entries in order.

Cookie

Get, set, check, and forget cookies.

Dictionary

Allows you to loop through options from a Dictionary.

Dump

Debugs variables in current view context

Foreach

Loops through keys in a named key/value array

Form

Handles the frontend side of your forms.

Form:Create

Manages markup and success/error handling for forms.

Form:Errors

Provides access to form errors.

Form:Set

Wraps other form tags to group them by the same formset.

Form:Submission

Accesses the data from a successful submission.

Form:Submissions

Fetches data from form submissions.

Form:Success

This is how you check if a form was successful outside of a form:create tag.

Get Content

Fetches content by URL or ID

Get Error

Gets a validation error

Get Errors

Gets validation errors

Get Files

Retrieves and filters local files

Get Site

Fetches a site's config, given it's handle.

Glide

Manipulates images on the fly

Glide:Batch

Manipulates a whole batch of <img> tags

Glide:Data_URL

Manipulates an image and returns a data URL

Increment

Creates incrementing indexes inside loops

Installed

Determine whether or not a Composer package is installed.

Link

Generates URLs

Locales

Create links to localized content.

Locales:Count

Get the number of localizations.

Loop

Loop a specified number of times

Markdown

Transforms inline Markdown written in your template.

Markdown:Indent

Transforms inline Markdown while ignoring whitespace

Mix

Returns the path to a versioned Mix file

Mount URL

The Mount URL tag is used to return the URL to a collection's mount entry.

Nav

Creates site navigations.

Nav:Breadcrumbs

Display breadcrumb-style navigation links to your current page.

No Cache

Keeps a chunk of your template dynamic inside of an otherwise cached area.

OAuth

Generate OAuth login URLs.

Obfuscate

Obfuscates content to foil screen-scraping nightmare bots from hell

Parent

Fetches data from a parent entry

Partial

Renders a partial view

Partial:Exists

Checks if a partial exists.

Partial:If_Exists

Renders a partial if it exists.

Protect:Password_Form

This tag is used to create a custom content password protection form.

Redirect

Redirects visitor to another URL

Route

Generate URLs to your named routes

Scope

Used to push all of the "root", or page scope data into an array to be used however you see fit.

Search

Performs searches and displays matching results

Section

Extracts markup to be rendered elsewhere with yield.

Session

Get, set, check, and forget data in your user's session.

Session:Dump

Peek into the user session for debugging purposes.

Session:Flash

Store data for a single request.

Session:Flush

Clears the entire user session.

Session:Forget

Remove data from the user session.

Session:Has

Check if data exists in the user session.

Session:Set

Store and persist data in the user session.

SVG

Renders inline SVGs

Switch

Loops a given set of values repeatedly

Taxonomy

Fetches and filters terms in one or more taxonomies.

Taxonomy:Count

Fetches the number of terms in a taxonomy

Translate

Retrieve a string from a language file in the current locale.

User_Groups

Fetch and iterate over User Groups and their data.

User_Roles

Fetch, and iterate over Users Roled and their data.

User:Can

Checks if a user has a specific permission

User:Forgot_Password_Form

Creates a "Forgot Password" form

User:In

Checks if a user is in a specific user group

User:Is

Checks if a user has a specific role

User:Login_Form

Creates user login forms

User:Logout

Logs a user out and redirects them elsewhere

User:Logout_URL

Generates a user logout URL

User:Password_Form

Creates a user password update form

User:Profile

Fetches user data.

User:Profile_Form

Creates user profile edit forms

User:Register_Form

Creates user registration forms

User:Reset_Password_Form

Creates a "Create a New Password" form

Users

Fetch, filter, and iterate over Users and their data.

Vite

Returns the path to Vite assets

Vite:Content

Returns the contents of a Vite asset

Yield

Displays content extracted elsewhere by the section tag

Hello there! Are you looking for the Statamic v2 documentation?