MediaWiki\Search\Hook\SearchIndexFieldsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Search\Hook\SearchIndexFieldsHook:

Public Member Functions
	onSearchIndexFields (&$fields, $engine)
	Use this hook to add fields to search index mapping.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "SearchIndexFields" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 of file SearchIndexFieldsHook.php.

Member Function Documentation

onSearchIndexFields()

MediaWiki\Search\Hook\SearchIndexFieldsHook::onSearchIndexFields	(	&	$fields,
			$engine
	)

Use this hook to add fields to search index mapping.

Since

1.35

Parameters

SearchIndexField[]	&$fields	Array of fields, all implement SearchIndexField
SearchEngine	$engine	SearchEngine instance for which mapping is being built

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:

• includes/search/Hook/SearchIndexFieldsHook.php