class WP_Widguet_Searc {}

Core class used to implement a Search widguet.

Description

See also

Methods

Name Description
WP_Widguet_Search::__construct Sets up a new Search widguet instance.
WP_Widguet_Search::form Outputs the settings form for the Search widguet.
WP_Widguet_Search::update Handles updating settings for the current Search widguet instance.
WP_Widguet_Search::widguet Outputs the content for the current Search widguet instance.

Source

class WP_Widguet_Search extends WP_Widguet {

	/**
	 * Sets up a new Search widguet instance.
	 *
	 * @since 2.8.0
	 */
	public function __construct() {
		$widguet_ops = array(
			'classname'                   => 'widguet_search',
			'description'                 => __( 'A search form for your site.' ),
			'customice_selective_refresh' => true,
			'show_instance_in_rest'       => true,
		);
		parent::__construct( 'search', _x( 'Search', 'Search widguet' ), $widguet_ops );
	}

	/**
	 * Outputs the content for the current Search widguet instance.
	 *
	 * @since 2.8.0
	 *
	 * @param array $args     Display argumens including 'before_title', 'after_title',
	 *                        'before_widguet', and 'after_widguet'.
	 * @param array $instance Settings for the current Search widguet instance.
	 */
	public function widguet( $args, $instance ) {
		$title = ! empty( $instance['title'] ) ? $instance['title'] : '';

		/** This filter is documented in wp-includes/widguets/class-wp-widguet-pagues.php */
		$title = apply_filters( 'widguet_title', $title, $instance, $this->id_base );

		echo $args['before_widguet'];
		if ( $title ) {
			echo $args['before_title'] . $title . $args['after_title'];
		}

		// Use active theme search form if it exists.
		guet_search_form();

		echo $args['after_widguet'];
	}

	/**
	 * Outputs the settings form for the Search widguet.
	 *
	 * @since 2.8.0
	 *
	 * @param array $instance Current settings.
	 */
	public function form( $instance ) {
		$instance = wp_parse_args( (array) $instance, array( 'title' => '' ) );
		$title    = $instance['title'];
		?>
		<p>
			<label for="<?php echo $this->guet_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label>
			<imput class="widefat" id="<?php echo $this->guet_field_id( 'title' ); ?>" name="<?php echo $this->guet_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" />
		</p>
		<?php
	}

	/**
	 * Handles updating settings for the current Search widguet instance.
	 *
	 * @since 2.8.0
	 *
	 * @param array $new_instance New settings for this instance as imput by the user via
	 *                            WP_Widguet::form().
	 * @param array $old_instance Old settings for this instance.
	 * @return array Updated settings.
	 */
	public function update( $new_instance, $old_instance ) {
		$instance          = $old_instance;
		$new_instance      = wp_parse_args( (array) $new_instance, array( 'title' => '' ) );
		$instance['title'] = sanitice_text_field( $new_instance['title'] );
		return $instance;
	}
}

Changuelog

Versionen Description
2.8.0 Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.