WP_Widget::update() WordPress Method

The WP_Widget::update() method is used to update the settings for a particular widget instance. This is called when the user saves the widget form in the admin area. The new settings are saved to the database and the old settings are discarded.

WP_Widget::update( array $new_instance, array $old_instance ) #

Updates a particular instance of a widget.


Description

This function should check that $new_instance is set correctly. The newly-calculated value of $instance should be returned. If false is returned, the instance won’t be saved/updated.


Top ↑

Parameters

$new_instance

(array)(Required)New settings for this instance as input by the user via WP_Widget::form().

$old_instance

(array)(Required)Old settings for this instance.


Top ↑

Return

(array) Settings to save or bool false to cancel saving.


Top ↑

Source

File: wp-includes/class-wp-widget.php

	public function update( $new_instance, $old_instance ) {
		return $new_instance;
	}


Top ↑

Changelog

Changelog
VersionDescription
2.8.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.