MediaWiki\Rest\Hook\SearchResultProvideDescriptionHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onSearchResultProvideDescription (array $pageIdentities, &$descriptions)
	This hook is called when generating search results in order to fill the 'description' field in an extension.

Detailed Description

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

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

Called by REST SearchHandler in order to allow extensions to fill the 'description' field in search results. Warning: this hook, as well as SearchResultPageIdentity interface, is under development and still unstable.

Stability: unstable

Definition at line 16 of file SearchResultProvideDescriptionHook.php.

Member Function Documentation

onSearchResultProvideDescription()

MediaWiki\Rest\Hook\SearchResultProvideDescriptionHook::onSearchResultProvideDescription	(	array	$pageIdentities,
		&	$descriptions )

This hook is called when generating search results in order to fill the 'description' field in an extension.

Since

1.35

Parameters

array	$pageIdentities	Array (string=>SearchResultPageIdentity) where key is pageId
array	&$descriptions	Output array (string=>string|null) where key is pageId and value is either a description for given page or null

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Rest/Hook/SearchResultProvideDescriptionHook.php