WP_Theme_JSON::remove_insecure_properties( array $theme_json, string $origin ): array

In this article

Removes insecure data from theme.json.

Parameters

$theme_jsonarrayrequired
Structure to sanitize.
$originstringoptional
What source of data this object represents.
One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.

Return

array Sanitized structure.

Source

public static function remove_insecure_properties( $theme_json, $origin = 'theme' ) {
	if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {
		$origin = 'theme';
	}

	$sanitized = array();

	$theme_json = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );

	$blocks_metadata     = static::get_blocks_metadata();
	$valid_block_names   = array_keys( $blocks_metadata );
	$valid_element_names = array_keys( static::ELEMENTS );
	$valid_variations    = static::get_valid_block_style_variations( $blocks_metadata );

	$theme_json = static::sanitize( $theme_json, $valid_block_names, $valid_element_names, $valid_variations );

	$blocks_metadata = static::get_blocks_metadata();
	$style_options   = array( 'include_block_style_variations' => true ); // Allow variations data.
	$style_nodes     = static::get_style_nodes( $theme_json, $blocks_metadata, $style_options );

	foreach ( $style_nodes as $metadata ) {
		$input = _wp_array_get( $theme_json, $metadata['path'], array() );
		if ( empty( $input ) ) {
			continue;
		}

		// The global styles custom CSS is not sanitized, but can only be edited by users with 'edit_css' capability.
		if ( isset( $input['css'] ) && current_user_can( 'edit_css' ) ) {
			$output = $input;
		} else {
			$output = static::remove_insecure_styles( $input );
		}

		/*
		 * Get a reference to element name from path.
		 * $metadata['path'] = array( 'styles', 'elements', 'link' );
		 */
		$current_element = $metadata['path'][ count( $metadata['path'] ) - 1 ];

		/*
		 * $output is stripped of pseudo selectors. Re-add and process them
		 * or insecure styles here.
		 */
		if ( isset( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $current_element ] ) ) {
			foreach ( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $current_element ] as $pseudo_selector ) {
				if ( isset( $input[ $pseudo_selector ] ) ) {
					$output[ $pseudo_selector ] = static::remove_insecure_styles( $input[ $pseudo_selector ] );
				}
			}
		}

		if ( ! empty( $output ) ) {
			_wp_array_set( $sanitized, $metadata['path'], $output );
		}

		if ( isset( $metadata['variations'] ) ) {
			foreach ( $metadata['variations'] as $variation ) {
				$variation_input = _wp_array_get( $theme_json, $variation['path'], array() );
				if ( empty( $variation_input ) ) {
					continue;
				}

				$variation_output = static::remove_insecure_styles( $variation_input );

				if ( isset( $variation_input['blocks'] ) ) {
					$variation_output['blocks'] = static::remove_insecure_inner_block_styles( $variation_input['blocks'] );
				}

				if ( isset( $variation_input['elements'] ) ) {
					$variation_output['elements'] = static::remove_insecure_element_styles( $variation_input['elements'] );
				}

				if ( ! empty( $variation_output ) ) {
					_wp_array_set( $sanitized, $variation['path'], $variation_output );
				}
			}
		}
	}

	$setting_nodes = static::get_setting_nodes( $theme_json );
	foreach ( $setting_nodes as $metadata ) {
		$input = _wp_array_get( $theme_json, $metadata['path'], array() );
		if ( empty( $input ) ) {
			continue;
		}

		$output = static::remove_insecure_settings( $input );
		if ( ! empty( $output ) ) {
			_wp_array_set( $sanitized, $metadata['path'], $output );
		}
	}

	if ( empty( $sanitized['styles'] ) ) {
		unset( $theme_json['styles'] );
	} else {
		$theme_json['styles'] = $sanitized['styles'];
	}

	if ( empty( $sanitized['settings'] ) ) {
		unset( $theme_json['settings'] );
	} else {
		$theme_json['settings'] = $sanitized['settings'];
	}

	return $theme_json;
}

Changelog

VersionDescription
6.6.0Updated to allow variation element styles and $origin parameter.
6.3.2Preserves global styles block variations when securing styles.
5.9.0Introduced.

User Contributed Notes

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