wppaste
WordPress

apply_filters( 'search_form_format', string $format, array $args )

Since
3.6.0, 5.5.0
Filters the HTML format of the search form.

Compatibility

WordPress
since 5.5.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$formatstring
The type of markup to use in the search form.
Accepts 'html5', 'xhtml'.
$argsarray
The array of arguments for building the search form.
See get_search_form() for information on accepted arguments.

Where this hook fires · 1

  • wp-includes/general-template.php:304get_search_form()

Source code

	 *	 * @param string $format The type of markup to use in the search form.	 *                       Accepts 'html5', 'xhtml'.	 * @param array  $args   The array of arguments for building the search form.	 *                       See get_search_form() for information on accepted arguments.	 */	$format = apply_filters( 'search_form_format', $format, $args ); 	$search_form_template = locate_template( 'searchform.php' ); 	if ( '' !== $search_form_template ) {		ob_start();		require $search_form_template;

Changelog

Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

5.5.0
The $args parameter was added.from the docblock
3.6.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.