WP_List_Table::search_box() WordPress Method
The WP_List_Table::search_box() method is used to display a search box for searching through posts and pages in the WordPress admin. This is a powerful tool for finding content on your site, and it is easy to use. Simply enter a search term into the box and click the search button. The results will be displayed in a list format, with the most relevant results appearing first.
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.
More Information
This renders a search box. To use this, you will still need to manually wrap your list table (including search box) in a form.
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 }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |