Manual:Hooks/SearchIndexFields

From Linux Web Expert

SearchIndexFields
<translate> Available from <tvar name=1><translate> version <tvar </tvar></translate>
Add fields to search index mapping
<translate> Define function:</translate>
public static function onSearchIndexFields( array &$fields, SearchEngine $engine ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"SearchIndexFields": "MediaWiki\\Extension\\MyExtension\\Hooks::onSearchIndexFields"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> SearchEngine.php
<translate> Interface:</translate> SearchIndexFieldsHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:SearchIndexFields extensions</tvar>.</translate>


Details

  • array &$fields: Array of fields, all implement SearchIndexField.
  • SearchEngine $engine: SearchEngine instance for which mapping is being built.

Extension that wants to add a field to search index mapping can use this hook to inject search fields.