Skip to content

Template

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\Template
Since
3.0.0

Class Template

View source

Public Methods

MethodDescription
beginProfile()Begins profiling a template element.
css()Registers a CSS file or a CSS code block.
endProfile()Finishes profiling a template element.
js()Registers a JS file or a JS code block.
paginateCriteria()Paginates a query.
paginateQuery()Paginates a query.
raw()Returns a string wrapped in a \Twig\Markup object
resolveTemplatePathAndLine()Attempts to resolve a compiled template file path and line number to its source template path and line number.

beginProfile()

Since
3.3.0

Begins profiling a template element.

View source

Arguments

  • $type (string) – The type of template element being profiled ('template', 'block', or 'macro')
  • $name (string) – The name of the template element

css()

Since
3.5.6

Registers a CSS file or a CSS code block.

View source

Arguments

  • $css (string) – The CSS file URL, or the content of the CSS code block to be registered
  • $options (array) – The HTML attributes for the <link>/<style> tag.
  • $key (string, null) – The key that identifies the CSS code block. If null, it will use $css as the key. If two CSS code blocks are registered with the same key, the latter will overwrite the former.

Throws

endProfile()

Since
3.3.0

Finishes profiling a template element.

View source

Arguments

  • $type (string) – The type of template element being profiled ('template', 'block', or 'macro')
  • $name (string) – The name of the template element

js()

Since
3.5.6

Registers a JS file or a JS code block.

View source

Arguments

  • $js (string) – The JS file URL, or the content of the JS code block to be registered
  • $options (array) – The HTML attributes for the <script> tag.
  • $key (string, null) – The key that identifies the JS code block. If null, it will use $css as the key. If two JS code blocks are registered with the same key, the latter will overwrite the former.

Throws

paginateCriteria()

DEPRECATED

Deprecated in 3.6.0. Use paginateQuery() instead.

Paginates a query.

View source

Arguments

Returns

array

paginateQuery()

Since
3.6.0

Paginates a query.

View source

Arguments

Returns

array

raw()

Returns a string wrapped in a \Twig\Markup object

View source

Arguments

Returns

\Twig\Markup

resolveTemplatePathAndLine()

Since
3.7.49

Attempts to resolve a compiled template file path and line number to its source template path and line number.

View source

Arguments

  • $path (string) – The compiled template path
  • $line (integer, null) – The line number from the compiled template

Returns

array, false – The resolved template path and line number, or false if the path couldn’t be determined. If a template path could be determined but not the template line number, the line number will be null.

Constants

ConstantDescription
PROFILE_STAGE_BEGIN
PROFILE_STAGE_END
PROFILE_TYPE_BLOCK
PROFILE_TYPE_MACRO
PROFILE_TYPE_TEMPLATE