MediaWiki\Rest\Hook\SearchResultProvideThumbnailHook Interface Reference

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

Inheritance diagram for MediaWiki\Rest\Hook\SearchResultProvideThumbnailHook:

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

Detailed Description

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

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

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

Stability: unstable

Definition at line 16 of file SearchResultProvideThumbnailHook.php.

Member Function Documentation

onSearchResultProvideThumbnail()

MediaWiki\Rest\Hook\SearchResultProvideThumbnailHook::onSearchResultProvideThumbnail	(	array	$pageIdentities,
		&	$thumbnails
	)

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

Since

1.35

Parameters

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

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Rest/Hook/SearchResultProvideThumbnailHook.php