WP_Theme_JSON::remove_insecure_properties( array $theme_json, string $origin = 'theme' ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$theme_jsonarray

Structure to sanitize.

$originstringoptional

What source of data this object represents.
One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.Default: 'theme'

Return value

array

Sanitized structure.

Performance profile

How much work a call to WP_Theme_JSON::remove_insecure_properties() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

61–67

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 199.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme_JSON::remove_insecure_properties() can have, taken from its control-flow graph on PHP 8.5.

Uses · 13

• _wp_array_get()Accesses an array in depth based on a path of keys.
• current_user_can()Returns whether the current user has the specified capability.
• _wp_array_set()Sets an array in depth based on a path of keys.
• WP_Theme_JSON_Schema::migrate()Function that migrates a given theme.json structure to the last version.
• static::get_blocks_metadata()
• static::get_valid_block_style_variations()
• static::sanitize()
• static::get_style_nodes()
• static::remove_insecure_styles()
• static::remove_insecure_inner_block_styles()
• static::remove_insecure_element_styles()
• static::get_setting_nodes()

Used by · 2

• _wp_add_block_level_preset_styles()Render the block level presets stylesheet.
• wp_filter_global_styles_post()Sanitizes global styles user content removing unsafe rules.

Source code

View on Trac ↗View on GitHub ↗

3516	public static function remove_insecure_properties( $theme_json, $origin = 'theme' ) {3517		if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {3518			$origin = 'theme';3519		}3520 3521		$sanitized = array();3522 3523		$theme_json = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );3524 3525		$blocks_metadata     = static::get_blocks_metadata();3526		$valid_block_names   = array_keys( $blocks_metadata );3527		$valid_element_names = array_keys( static::ELEMENTS );3528		$valid_variations    = static::get_valid_block_style_variations( $blocks_metadata );3529 3530		$theme_json = static::sanitize( $theme_json, $valid_block_names, $valid_element_names, $valid_variations );3531 3532		$blocks_metadata = static::get_blocks_metadata();3533		$style_options   = array( 'include_block_style_variations' => true ); // Allow variations data.3534		$style_nodes     = static::get_style_nodes( $theme_json, $blocks_metadata, $style_options );3535 3536		foreach ( $style_nodes as $metadata ) {3537			$input = _wp_array_get( $theme_json, $metadata['path'], array() );3538			if ( empty( $input ) ) {3539				continue;3540			}3541 3542			// The global styles custom CSS is not sanitized, but can only be edited by users with 'edit_css' capability.3543			if ( isset( $input['css'] ) && current_user_can( 'edit_css' ) ) {3544				$output = $input;3545			} else {3546				$output = static::remove_insecure_styles( $input );3547			}3548 3549			/*3550			 * Get a reference to element name from path.3551			 * $metadata['path'] = array( 'styles', 'elements', 'link' );3552			 */3553			$current_element = $metadata['path'][ count( $metadata['path'] ) - 1 ];3554 3555			/*3556			 * $output is stripped of pseudo selectors. Re-add and process them3557			 * or insecure styles here.3558			 */3559			if ( isset( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $current_element ] ) ) {3560				foreach ( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $current_element ] as $pseudo_selector ) {3561					if ( isset( $input[ $pseudo_selector ] ) ) {3562						$output[ $pseudo_selector ] = static::remove_insecure_styles( $input[ $pseudo_selector ] );3563					}3564				}3565			}3566 3567			if ( ! empty( $output ) ) {3568				_wp_array_set( $sanitized, $metadata['path'], $output );3569			}3570 3571			if ( isset( $metadata['variations'] ) ) {3572				foreach ( $metadata['variations'] as $variation ) {3573					$variation_input = _wp_array_get( $theme_json, $variation['path'], array() );3574					if ( empty( $variation_input ) ) {3575						continue;3576					}3577 3578					$variation_output = static::remove_insecure_styles( $variation_input );3579 3580					if ( isset( $variation_input['blocks'] ) ) {3581						$variation_output['blocks'] = static::remove_insecure_inner_block_styles( $variation_input['blocks'] );3582					}3583 3584					if ( isset( $variation_input['elements'] ) ) {3585						$variation_output['elements'] = static::remove_insecure_element_styles( $variation_input['elements'] );3586					}3587 3588					if ( ! empty( $variation_output ) ) {3589						_wp_array_set( $sanitized, $variation['path'], $variation_output );3590					}3591				}3592			}3593		}3594 3595		$setting_nodes = static::get_setting_nodes( $theme_json );

Changelog

Introduced in 5.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-theme-json.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.