WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Widget::get_settings()

WP_Widget::get_settings(): array

In this article

Back to top

Retrieves the settings for all instances of the widget class.

Return

array Multi-dimensional array of widget instance settings.

Source

public function get_settings() {

	$settings = get_option( $this->option_name );

	if ( false === $settings ) {
		$settings = array();
		if ( isset( $this->alt_option_name ) ) {
			// Get settings from alternative (legacy) option.
			$settings = get_option( $this->alt_option_name, array() );

			// Delete the alternative (legacy) option as the new option will be created using `$this->option_name`.
			delete_option( $this->alt_option_name );
		}
		// Save an option so it can be autoloaded next time.
		$this->save_settings( $settings );
	}

	if ( ! is_array( $settings ) && ! ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) ) {
		$settings = array();
	}

	if ( ! empty( $settings ) && ! isset( $settings['_multiwidget'] ) ) {
		// Old format, convert if single widget.
		$settings = wp_convert_widget_settings( $this->id_base, $this->option_name, $settings );
	}

	unset( $settings['_multiwidget'], $settings['__i__'] );

	return $settings;
}

View all references View on Trac View on GitHub

UsesDescription
delete_option()wp-includes/option.php

Removes an option by name. Prevents removal of protected WordPress options.

WP_Widget::save_settings()wp-includes/class-wp-widget.php

Saves the settings for all instances of the widget class.

wp_convert_widget_settings()wp-includes/widgets.php

Converts the widget settings from single to multi-widget format.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Show 1 moreShow less
Used byDescription
WP_Widget::display_callback()wp-includes/class-wp-widget.php

Generates the actual widget content (Do NOT override).

WP_Widget::update_callback()wp-includes/class-wp-widget.php

Handles changed settings (Do NOT override).

WP_Widget::form_callback()wp-includes/class-wp-widget.php

Generates the widget control form (Do NOT override).

WP_Widget::_register()wp-includes/class-wp-widget.php

Register all widget instances of this widget class.

Changelog

VersionDescription
2.8.0Introduced.

User Contributed Notes

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