Difference between revisions of "Liquid Template Variables - search"

From Spiffy Stores Knowledge Base

m
 
(3 intermediate revisions by the same user not shown)
Line 18: Line 18:
  
 
== <code>search.results_count</code> ==
 
== <code>search.results_count</code> ==
 +
 +
Returns the number of results found.
  
 
== <code>search.terms</code> ==
 
== <code>search.terms</code> ==
 +
 +
Returns the original string that was submitted for the search.
 +
 +
The ''highlight'' filter can be used to apply a different style to any instances in the search results that match up with ''search.terms''.
 +
 +
<pre>
 +
{{ item.content | highlight: search.terms }}
 +
</pre>
 +
 +
== Further Reference ==
 +
 +
* [[Liquid Basics]]
 +
* [[Liquid Tag Reference]]
 +
* [[Liquid Filter Reference]]
 +
* [[Liquid Variable Reference]]
 +
* [[Liquid Paginate Tag|Pagination ]]

Latest revision as of 12:24, 25 June 2018

The Liquid template variable search has the following attributes:

search.performed

Returns true if a successful search was performed.

search.results

Returns an array of search results. The search items may be a

In addition to the standard attributes returned by the respective variables, an additional attribute object_type is supported to distiguish each of the search results.

search.results_count

Returns the number of results found.

search.terms

Returns the original string that was submitted for the search.

The highlight filter can be used to apply a different style to any instances in the search results that match up with search.terms.

{{ item.content | highlight: search.terms }}

Further Reference