WP_Widget_Search::widget() WordPress Method
The WP_Widget_Search::widget() method allows a search widget to be displayed in a Wordpress sidebar. This method takes two parameters: the first is the search query string, and the second is an array of options. The search widget will then use these parameters to display the search results.
WP_Widget_Search::widget( array $args, array $instance ) #
Outputs the content for the current Search widget instance.
Parameters
- $args
(array)(Required)Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
- $instance
(array)(Required)Settings for the current Search widget instance.
Source
File: wp-includes/widgets/class-wp-widget-search.php
public function widget( $args, $instance ) {
$title = ! empty( $instance['title'] ) ? $instance['title'] : '';
/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
echo $args['before_widget'];
if ( $title ) {
echo $args['before_title'] . $title . $args['after_title'];
}
// Use active theme search form if it exists.
get_search_form();
echo $args['after_widget'];
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |