do_action( 'pre_get_search_form', array $args )
Fires before the search form is retrieved, at the start of get_search_form() .
Parameters
-
$argsarray -
The array of arguments for building the search form.
See get_search_form() for information on accepted arguments.More Arguments from get_search_form( ... $args )
Array of display arguments.
echoboolWhether to echo or return the form. Default true.aria_labelstringARIA label for the search form. Useful to distinguish multiple search forms on the same page and improve accessibility.
Source
File: wp-includes/general-template.php.
View all references
do_action( 'pre_get_search_form', $args );
Changelog
| Version | Description |
|---|---|
| 5.5.0 | The $args parameter was added. |
| 3.6.0 | |
| 2.7.0 | Introduced. |