Search

{% search %}

Fetches a list of pages on the site that match the given searchterm.

{% search output_to_template? [[var, set, or assign]? variable]? output_to_template? = searchterm attributes %}

{% search

output_to_template

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

var, set, or assign

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

variable

output_to_template

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

searchterm

attributes

Key:value pairs with unique keys. May use the variable arguments syntax.

attributes

type

Entity type to search (e.g., article, image)

domain_name

Limit the search to a specific domain name

limit

Max results to return (integer). Must be between 1 and 1000. Defaults to 25

start

Zero-based index to start from (integer)

page

Page number for paged results (integer), starting from 1

Examples

Demonstrates how to search with query parameters and limit result length.

{%- var page = request.query_params.p | default:1 -%}
{%- var limit = request.query_params.l | default:25 -%}
{%- search set results request.query_params.q page:page limit:limit -%}

Demonstrates how to search only blog post entities by a query parameter.

{% search output_to_template request.query_params.q type:blog_post %}

Search

Search

{% search %}

Related

Examples