1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
<?php
namespace MediaWiki\Rest\Hook;
/**
* 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.
*
* @unstable
* @ingroup Hooks
*/
interface SearchResultProvideDescriptionHook {
/**
* This hook is called when generating search results in order to fill the 'description'
* field in an extension.
*
* @since 1.35
*
* @param array $pageIdentities Array (string=>SearchResultPageIdentity) where key is pageId
* @param array &$descriptions Output array (string=>string|null) where key
* is pageId and value is either a description for given page or null
*/
public function onSearchResultProvideDescription( array $pageIdentities, &$descriptions );
}
|
