< Manual:Hooks
 | This deprecated feature should no longer be used, but is still available for reasons of backwards compatibility. This feature was deprecated in version 1.40.0. Please see Hooks/SearchDataForIndex2 for an alternative way to use this feature. |
| SearchDataForIndex | |
|---|---|
| Available from version 1.28.0 Allows to provide custom content fields when indexing a document. | |
| Define function: | public static function onSearchDataForIndex( array &$fields, ContentHandler $handler, WikiPage $page, ParserOutput $output, SearchEngine $engine ) { ... }
|
| Attach hook: | In extension.json:
{
"Hooks": {
"SearchDataForIndex": "MyExtensionHooks::onSearchDataForIndex"
}
}
|
| Called from: | File(s): SearchEngine.php |
| Interface: | SearchDataForIndexHook.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:SearchDataForIndex extensions.
Details
- array &$fields: Array of name => value pairs for fields
- ContentHandler $handler: ContentHandler for the content being indexed
- WikiPage $page: WikiPage that is being indexed
- ParserOutput $output: ParserOutput that is produced from the page
- SearchEngine $engine: SearchEngine for which the indexing is intended
Add data to search document. Allows an extension to add any data to the field map used to index the document.
This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.