Plugin/Events/Finder

From Joomla! Documentation

< Plugin‎ | Events
Copyedit.png
This Article Needs Your Help

This article is tagged because it NEEDS COMPLETION. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.

Reason: This page need completing to be a useful doc reference.


onFinderCategoryChangeState[edit]

Description[edit]

Parameters[edit]

Return Value[edit]

Called in files[edit]

onFinderChangeState[edit]

Description[edit]

Parameters[edit]

Return Value[edit]

Called in files[edit]

onFinderAfterDelete[edit]

Description[edit]

Parameters[edit]

Return Value[edit]

Called in files[edit]

onFinderAfterDelete[edit]

Description[edit]

Parameters[edit]

Return Value[edit]

Called in files[edit]

onFinderBeforeSave[edit]

Description[edit]

Parameters[edit]

Return Value[edit]

Called in files[edit]

onFinderAfterSave[edit]

Description[edit]

Parameters[edit]

Return Value[edit]

Called in files[edit]

onFinderResult Joomla 4.0[edit]

Description[edit]

Event triggered before rendering a results.

Parameters[edit]

  • $result An object for single result
  • $query A query object Joomla\Component\Finder\Administrator\Indexer\Query

Return Value[edit]

Return void

Called in files[edit]

Called from Joomla\Component\Finder\Site\View\Search\HtmlView::display()

onPrepareFinderContent[edit]

Description[edit]

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[edit]

$item A FinderIndexerResult object containing the data to be indexed.

Return Value[edit]

Return void or false for error (this will trigger Exception),

Called in files[edit]

Called from FinderIndexerHelper::getContentExtras()