You are viewing the documentation for an older version of this package. You can check the version you are using with the following command:

composer show spatie/laravel-site-search

Retrieving results

On this page

  1. Getting all results
  2. Limiting results
  3. Paginating results

You can retrieve results from an index using Spatie\SiteSearch\Search.

Here's how you can retrieve all results from an index named my-index.

use Spatie\SiteSearch\Search;

$searchResults = Search::onIndex('my-index')
    ->query('your query')
    ->get(); // returns all results

You can limit the amount of results using the limit function.

use Spatie\SiteSearch\Search;

$searchResults = Search::onIndex('my-index')
    ->query('your query')
    ->limit(20)
    ->get(); // returns the first 20 results

You can paginate results using by calling paginate.

use Spatie\SiteSearch\Search;

$searchResults = Search::onIndex('my-index')
    ->query('your query')
    ->paginate(20); // returns an instance of `Illuminate\Pagination\Paginator` with 20 results per page
Indexing your first site
Preventing content from being indexed
Help us improve this page