W3cubDocs

/WordPress

WP_List_Table::search_box( string $text, string $input_id )

Displays the search box.

Parameters

$text

(string) (Required) The 'submit' button label.

$input_id

(string) (Required) ID attribute value for the search input field.

Source

File: wp-admin/includes/class-wp-list-table.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
	}

Uses

Uses Description
wp-admin/includes/class-wp-list-table.php: WP_List_Table::has_items()

Whether the table has items to display or not
wp-admin/includes/template.php: _admin_search_query()

Displays the search query.
wp-admin/includes/template.php: submit_button()

Echoes a submit button, with provided text and appropriate class(es).
wp-includes/formatting.php: esc_attr()

Escaping for HTML attributes.

Changelog

Version Description
3.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_list_table/search_box