View source for Plugin/Events/Finder

{{page|needs completion|This page need completing to be a useful doc reference.}}

== onFinderCategoryChangeState ==

=== Description ===

=== Parameters ===

=== Return Value ===

=== Called in files ===

== onFinderChangeState ==

=== Description ===

=== Parameters ===

=== Return Value ===

=== Called in files ===

== onFinderAfterDelete ==

=== Description ===

=== Parameters ===

=== Return Value ===

=== Called in files ===

== onFinderAfterDelete ==

=== Description ===

=== Parameters ===

=== Return Value ===

=== Called in files ===

== onFinderBeforeSave ==

=== Description ===

=== Parameters ===

=== Return Value ===

=== Called in files ===

== onFinderAfterSave ==

=== Description ===

=== Parameters ===

=== Return Value ===

=== Called in files ===

== onFinderResult {{JVer|4.0}} == 

=== Description ===

Event triggered before rendering a results.

=== Parameters ===

*<code>$result</code> An object for single result
*<code>$query</code> A query object <code>Joomla\Component\Finder\Administrator\Indexer\Query</code>

=== Return Value ===
Return <code>void</code>

=== Called in files ===
Called from <code>Joomla\Component\Finder\Site\View\Search\HtmlView::display()</code>

== onPrepareFinderContent ==

=== Description ===

Event to add extra data for a content before being indexed. This is how we add Comments, Tags, Labels, etc. that should be available to Finder.

=== Parameters ===

<code>$item</code> A <code>FinderIndexerResult</code> object containing the data to be indexed.

=== Return Value ===

Return <code>void</code> or <code>false</code> for error (this will trigger Exception),

=== Called in files ===

Called from <code>FinderIndexerHelper::getContentExtras()</code>

<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>