Manual:Hooks/SpecialSearchProfileForm

From Linux Web Expert

Revision as of 11:14, 31 October 2022 by imported>Sophivorus (Fix syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

SpecialSearchProfileForm
<translate> Available from <tvar name=1><translate> version <tvar (r86714, codereview)</tvar></translate>
allows modification of search profile forms
<translate> Define function:</translate>
public static function onSpecialSearchProfileForm( SpecialSearch $search, &$form, &$profile, $term, array $opts ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"SpecialSearchProfileForm": "MediaWiki\\Extension\\MyExtension\\Hooks::onSpecialSearchProfileForm"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> specials/SpecialSearch.php
<translate> Interface:</translate> SpecialSearchProfileFormHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:SpecialSearchProfileForm extensions</tvar>.</translate>


Details

  • $search: SpecialSearch object
  • &$form: String: form html
  • $profile: String: current search profile
  • $term: String: search term
  • $opts: Array: key => value of hidden options for inclusion in custom forms

See also