\SearchWP\Indexer
Table of Contents
\SearchWP\Indexer
facilitates the indexing process of SearchWP. SearchWP’s indexer works alongside hooks set up in \SearchWP\Source
s to automatically keep the search Index up to date.
Basic Usage
If you are working with site customizations that do not align with the delta update hooks set up in \SearchWP\Source
s you may want to force an Index update. This can be done like so:
<?php | |
// @linkhttps://searchwp.com/documentation/classes/searchwp-indexer/ | |
// Forcefully trigger SearchWP's Indexer. | |
$indexer = new \SearchWP\Indexer(); | |
$indexer->trigger(); |
When the \SearchWP\Indexer
is triggered, any necessary delta updates will be queued and applied as though they were triggered by native hooks.
Arguments
There are no arguments when instantiating a new \SearchWP\Indexer
.
Properties
There are no public properties in \SearchWP\Indexer
.
Methods
When working with \SearchWP\Indexer
there are a number of methods to consider.
pause
- Pause the indexing process.
unpause
- Unpause the indexing process.
Hooks
There are a number of hooks available to further modify the behavior of \SearchWP\Indexer
: