WP_List_Table::search_box()publicWP 3.1.0

Displays the search box.

Method of the class: WP_List_Table{}

No Hooks.

Return

null. Nothing (null).

Usage

$WP_List_Table = new WP_List_Table();
$WP_List_Table->search_box( $text, $input_id );
$text(string) (required)
The 'submit' button label.
$input_id(string) (required)
ID attribute value for the search input field.

Changelog

Since 3.1.0 Introduced.

WP_List_Table::search_box() code WP 6.4.3

<?php
public function search_box( $text, $input_id ) {
	if ( empty( $_REQUEST['s'] ) && ! $this->has_items() ) {
		return;
	}

	$input_id = $input_id . '-search-input';

	if ( ! empty( $_REQUEST['orderby'] ) ) {
		echo '<input type="hidden" name="orderby" value="' . esc_attr( $_REQUEST['orderby'] ) . '" />';
	}
	if ( ! empty( $_REQUEST['order'] ) ) {
		echo '<input type="hidden" name="order" value="' . esc_attr( $_REQUEST['order'] ) . '" />';
	}
	if ( ! empty( $_REQUEST['post_mime_type'] ) ) {
		echo '<input type="hidden" name="post_mime_type" value="' . esc_attr( $_REQUEST['post_mime_type'] ) . '" />';
	}
	if ( ! empty( $_REQUEST['detached'] ) ) {
		echo '<input type="hidden" name="detached" value="' . esc_attr( $_REQUEST['detached'] ) . '" />';
	}
	?>
<p class="search-box">
<label class="screen-reader-text" for="<?php echo esc_attr( $input_id ); ?>"><?php echo $text; ?>:</label>
<input type="search" id="<?php echo esc_attr( $input_id ); ?>" name="s" value="<?php _admin_search_query(); ?>" />
	<?php submit_button( $text, '', '', false, array( 'id' => 'search-submit' ) ); ?>
</p>
	<?php
}