Open main menu

Manual:Hooks/SpecialSearchResults

< Manual:Hooks
SpecialSearchResults
Available from version 1.13.0
called before search result display when there are matches
Define function:
public static function onSpecialSearchResults( $term, $titleMatches, $textMatches ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"SpecialSearchResults": "MyExtensionHooks::onSpecialSearchResults"
	}
}

For MediaWiki ≤1.25:

$wgHooks['SpecialSearchResults'][] = 'MyExtensionHooks::onSpecialSearchResults';
Called from:File(s): SpecialSearch.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:SpecialSearchResults extensions.

DetailsEdit

  • $term: string of search term
  • $titleMatches: empty or SearchResultSet object
  • $textMatches: empty or SearchResultSet object

Old behaviourEdit

Referenced SearchResultSet can be easily wrapped for any purpose (caching results, etc). Please keep in mind that old behavior used no reference for SearchResultSet objects.

See alsoEdit