search​

Information regarding storefront search queries.

For information on storefront search and to learn about how to incorporate it into your theme, please refer to the Storefront search.

Properties​

Filters that have been applied on the search pages.

Only filters pertaining to current search results will be returned. The array will be empty if the search results have more than a thousand products.

If the search is successfully executed, it returns true. Otherwise, it returns false.

Search results items.

The item could be an article, a page, or a product.

The quantity of search results.

The sorting order of search results. It is decided by sort_by URL parameter.

If the sort_by URL parameter is not present, the value will be null.

Available sort options for search results.

The inputted search terms.

The object type on which the search is performed.

You can perform a search on the object types below:

• article
• page
• product