Available events | laravel-site-search | Spatie

 SPATIE

  Laravel Site Search
======================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-site-search](https://spatie.be/docs/laravel-site-search/v1)  Advanced-usage  Available events

 Version   v3   v1

 Other versions for crawler [v3](https://spatie.be/docs/laravel-site-search/v3) [v1](https://spatie.be/docs/laravel-site-search/v1)

- [ Introduction ](https://spatie.be/docs/laravel-site-search/v1/introduction)
- [ Support us ](https://spatie.be/docs/laravel-site-search/v1/support-us)
- [ Installation and setup ](https://spatie.be/docs/laravel-site-search/v1/installation-setup)
- [ About us ](https://spatie.be/docs/laravel-site-search/v1/about-us)
- [ Questions and issues ](https://spatie.be/docs/laravel-site-search/v1/questions-issues)
- [ Requirements ](https://spatie.be/docs/laravel-site-search/v1/requirements)
- [ Changelog ](https://spatie.be/docs/laravel-site-search/v1/changelog)

Basic usage
-----------

- [ High level overview ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/high-level-overview)
- [ Indexing your first site ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/indexing-your-first-site)
- [ Retrieving results ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/retrieving-results)
- [ Preventing content from being indexed ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/preventing-content-from-being-indexed)
- [ Using a search profile ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/using-a-search-profile)
- [ Authenticating requests ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/authenticating-requests)
- [ Listing indexes ](https://spatie.be/docs/laravel-site-search/v1/basic-usage/listing-indexes)

Advanced usage
--------------

- [ Creating multiple search indexes ](https://spatie.be/docs/laravel-site-search/v1/advanced-usage/creating-multiple-search-indexes)
- [ Using a custom indexer ](https://spatie.be/docs/laravel-site-search/v1/advanced-usage/using-a-custom-indexer)
- [ Indexing extra properties ](https://spatie.be/docs/laravel-site-search/v1/advanced-usage/indexing-extra-properties)
- [ Customizing Meilisearch settings ](https://spatie.be/docs/laravel-site-search/v1/advanced-usage/customizing-meilisearch-settings)
- [ Available events ](https://spatie.be/docs/laravel-site-search/v1/advanced-usage/available-events)

      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                                                                                                                                                                                                                                    `

Available events
================

###  On this page

1. [ IndexingStartEvent ](#content-indexingstartevent)
2. [ IndexingEndedEvent ](#content-indexingendedevent)
3. [ NewIndexCreatedEvent ](#content-newindexcreatedevent)
4. [ FailedToCrawlUrlEvent ](#content-failedtocrawlurlevent)

You can listen for these events to add extra functionality.

IndexingStartEvent
--------------------------------------------------------------------------------------------------------------

This event will be fired when the indexing process starts, right before a search index is created.

It has these properties:

- `siteSearchConfig`: an instance of `SiteSearchConfig` for which the indexing process is starting

IndexingEndedEvent
--------------------------------------------------------------------------------------------------------------

This event will be fired when the indexing process has ended.

It has these properties:

- `siteSearchConfig`: an instance of `SiteSearchConfig` for which the indexing process is starting

NewIndexCreatedEvent
--------------------------------------------------------------------------------------------------------------------

Right before we start crawling a site, a new search index will be created, firing off this event.

It has these properties:

- `newIndexName` the name of the new search index
- `siteSearchConfig`: an instance of `SiteSearchConfig` for which the new event has been created

FailedToCrawlUrlEvent
-----------------------------------------------------------------------------------------------------------------------

Will be fired whenever crawling a page resulted in an error.

It has these properties:

- `url`: an instance of `UriInterface` containing the url that was crawled
- `requestException`: the exception itself
- `foundOnUrl`: an instance of `UriInterface` containing the url on which the crawled url was found