MediaWiki  master
MediaWiki\Content\Hook\SearchDataForIndexHook Interface Reference

Stable for implementation. More...

Inheritance diagram for MediaWiki\Content\Hook\SearchDataForIndexHook:

Public Member Functions

 onSearchDataForIndex (&$fields, $handler, $page, $output, $engine)
 Use this hook to add data to search document. More...
 

Detailed Description

Stable for implementation.

Definition at line 14 of file SearchDataForIndexHook.php.

Member Function Documentation

◆ onSearchDataForIndex()

MediaWiki\Content\Hook\SearchDataForIndexHook::onSearchDataForIndex ( $fields,
  $handler,
  $page,
  $output,
  $engine 
)

Use this hook to add data to search document.

Allows you to add any data to the field map used to index the document.

Since
1.35
Parameters
array&$fieldsArray of name => value pairs for fields
ContentHandler$handlerContentHandler for the content being indexed
WikiPage$pageWikiPage that is being indexed
ParserOutput$outputParserOutput that is produced from the page
SearchEngine$engineSearchEngine for which the indexing is intended
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: