WP_Customize_Widgets::sanitize_widget_instance( array $value, string $id_base = null )

Sanitizes a widget instance.


Description Description

Unserialize the JS-instance for storing in the options. It’s important that this filter only get applied to an instance once.


Top ↑

Parameters Parameters

$value

(array) (Required) Widget instance to sanitize.

$id_base

(string) (Optional) Base of the ID of the widget being sanitized.

Default value: null


Top ↑

Return Return

(array|void) Sanitized widget instance.


Top ↑

Source Source

File: wp-includes/class-wp-customize-widgets.php

	public function sanitize_widget_instance( $value, $id_base = null ) {
		global $wp_widget_factory;

		if ( array() === $value ) {
			return $value;
		}

		if ( isset( $value['raw_instance'] ) && $id_base && wp_use_widgets_block_editor() ) {
			$widget_object = $wp_widget_factory->get_widget_object( $id_base );
			if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) {
				if ( 'block' === $id_base && ! current_user_can( 'unfiltered_html' ) ) {
					/*
					 * The content of the 'block' widget is not filtered on the
					 * fly while editing. Filter the content here to prevent
					 * vulnerabilities.
					 */
					$value['raw_instance']['content'] = wp_kses_post( $value['raw_instance']['content'] );
				}

				return $value['raw_instance'];
			}
		}

		if (
			empty( $value['is_widget_customizer_js_value'] ) ||
			empty( $value['instance_hash_key'] ) ||
			empty( $value['encoded_serialized_instance'] )
		) {
			return;
		}

		$decoded = base64_decode( $value['encoded_serialized_instance'], true );
		if ( false === $decoded ) {
			return;
		}

		if ( ! hash_equals( $this->get_instance_hash_key( $decoded ), $value['instance_hash_key'] ) ) {
			return;
		}

		$instance = unserialize( $decoded );
		if ( false === $instance ) {
			return;
		}

		return $instance;
	}


Top ↑

Changelog Changelog

Changelog
Version Description
5.8.0 Added the $id_base parameter.
3.9.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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