WP_Customize_Widgets::sanitize_sidebar_widgets( string[] $widget_ids )

Ensures sidebar widget arrays only ever contain widget IDS.

Description

Used as the ‘sanitize_callback’ for each $sidebars_widgets setting.

Parameters

$widget_ids

(string[]) (Required) Array of widget IDs.

Return

(string[]) Array of sanitized widget IDs.

Source

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

public function sanitize_sidebar_widgets( $widget_ids ) {
		$widget_ids           = array_map( 'strval', (array) $widget_ids );
		$sanitized_widget_ids = array();
		foreach ( $widget_ids as $widget_id ) {
			$sanitized_widget_ids[] = preg_replace( '/[^a-z0-9_\-]/', '', $widget_id );
		}
		return $sanitized_widget_ids;
	}

Changelog

Version Description
3.9.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_widgets/sanitize_sidebar_widgets