Manual:Hooks/PrefixSearchBackend

From MediaWiki.org
Jump to navigation Jump to search
PrefixSearchBackend
Available from version 1.12.0
Override the title prefix search used for OpenSearch and AJAX search suggestions.
Define function:
public static function onPrefixSearchBackend( $ns, $search, $limit, &$results ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"PrefixSearchBackend": "MyExtensionHooks::onPrefixSearchBackend"
	}
}

For MediaWiki ≤1.25:

$wgHooks['PrefixSearchBackend'][] = 'MyExtensionHooks::onPrefixSearchBackend';
Called from:File(s): search/PrefixSearch.php, search/SearchEngine.php

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

Details[edit]

  • $ns: int namespace key to search in
  • $search: search term (not guaranteed to be conveniently normalized)
  • $limit: maximum number of results to return
  • &$results: out param: array of page names (strings)