install_search_form( bool $deprecated = true )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$deprecatedbooloptional

Not used.Default: true

Performance profile

How much work a call to install_search_form() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

65–82

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 84.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below install_search_form()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost install_search_form() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• _e()Displays translated text.
• esc_attr()Escaping for HTML attributes.
• selected()Outputs the HTML selected attribute.
• _ex()Displays translated string with gettext context.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).
• __()Retrieves the translation of $text.

Used by · 1

• WP_Plugin_Install_List_Table::views()Overrides parent views so we can use the filter bar display.

Source code

View on Trac ↗View on GitHub ↗

313function install_search_form( $deprecated = true ) {314	$type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term';315	$term = isset( $_REQUEST['s'] ) ? urldecode( wp_unslash( $_REQUEST['s'] ) ) : '';316	?>317	<form class="search-form search-plugins" method="get">318		<input type="hidden" name="tab" value="search" />319		<label for="search-plugins"><?php _e( 'Search Plugins' ); ?></label>320		<input type="search" name="s" id="search-plugins" value="<?php echo esc_attr( $term ); ?>" class="wp-filter-search" />321		<label class="screen-reader-text" for="typeselector">322			<?php323			/* translators: Hidden accessibility text. */324			_e( 'Search plugins by:' );325			?>326		</label>327		<select name="type" id="typeselector">328			<option value="term"<?php selected( 'term', $type ); ?>><?php _e( 'Keyword' ); ?></option>329			<option value="author"<?php selected( 'author', $type ); ?>><?php _e( 'Author' ); ?></option>330			<option value="tag"<?php selected( 'tag', $type ); ?>><?php _ex( 'Tag', 'Plugin Installer' ); ?></option>331		</select>332		<?php submit_button( __( 'Search Plugins' ), 'hide-if-js', false, false, array( 'id' => 'search-submit' ) ); ?>333	</form>334	<?php335}

Changelog

Introduced in 2.7.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.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/plugin-install.php, 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.