WP_Theme_JSON::sanitize( array $input, array $valid_block_names, array $valid_element_names, array $valid_variations ): array

Compatibility

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

Parameters

$inputarray

Structure to sanitize.

$valid_block_namesarray

List of valid block names.

$valid_element_namesarray

List of valid element names.

$valid_variationsarray

List of valid variations per block.

Return value

array

The sanitized output.

Performance profile

How much work a call to WP_Theme_JSON::sanitize() 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

7–67

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

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

Uses · 3

• static::schema_in_root_and_per_origin()
• static::remove_keys_not_in_schema()
• static::resolve_custom_css_format()

Source code

View on Trac ↗View on GitHub ↗

940	protected static function sanitize( $input, $valid_block_names, $valid_element_names, $valid_variations ) {941 942		$output = array();943 944		if ( ! is_array( $input ) ) {945			return $output;946		}947 948		// Preserve only the top most level keys.949		$output = array_intersect_key( $input, array_flip( static::VALID_TOP_LEVEL_KEYS ) );950 951		/*952		 * Remove any rules that are annotated as "top" in VALID_STYLES constant.953		 * Some styles are only meant to be available at the top-level (e.g.: blockGap),954		 * hence, the schema for blocks & elements should not have them.955		 */956		$styles_non_top_level = static::VALID_STYLES;957		foreach ( array_keys( $styles_non_top_level ) as $section ) {958			// array_key_exists() needs to be used instead of isset() because the value can be null.959			if ( array_key_exists( $section, $styles_non_top_level ) && is_array( $styles_non_top_level[ $section ] ) ) {960				foreach ( array_keys( $styles_non_top_level[ $section ] ) as $prop ) {961					if ( 'top' === $styles_non_top_level[ $section ][ $prop ] ) {962						unset( $styles_non_top_level[ $section ][ $prop ] );963					}964				}965			}966		}967 968		// Build the schema based on valid block & element names.969		$schema                 = array();970		$schema_styles_elements = array();971 972		/*973		 * Set allowed element pseudo selectors based on per element allow list.974		 * Target data structure in schema:975		 * e.g.976		 * - top level elements: `$schema['styles']['elements']['link'][':hover']`.977		 * - block level elements: `$schema['styles']['blocks']['core/button']['elements']['link'][':hover']`.978		 */979		foreach ( $valid_element_names as $element ) {980			$schema_styles_elements[ $element ] = $styles_non_top_level;981 982			if ( isset( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $element ] ) ) {983				foreach ( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $element ] as $pseudo_selector ) {984					$schema_styles_elements[ $element ][ $pseudo_selector ] = $styles_non_top_level;985				}986			}987		}988 989		$schema_styles_blocks   = array();990		$schema_settings_blocks = array();991 992		/*993		 * Generate a schema for blocks.994		 * - Block styles can contain `elements` & `variations` definitions.995		 * - Variations definitions cannot be nested.996		 * - Variations can contain styles for inner `blocks`.997		 * - Variation inner `blocks` styles can contain `elements`.998		 *999		 * As each variation needs a `blocks` schema but further nested1000		 * inner `blocks`, the overall schema will be generated in multiple passes.1001		 */1002		foreach ( $valid_block_names as $block ) {1003			$schema_settings_blocks[ $block ]           = static::VALID_SETTINGS;1004			$schema_styles_blocks[ $block ]             = $styles_non_top_level;1005			$schema_styles_blocks[ $block ]['elements'] = $schema_styles_elements;1006		}1007 1008		$block_style_variation_styles             = static::VALID_STYLES;1009		$block_style_variation_styles['blocks']   = $schema_styles_blocks;1010		$block_style_variation_styles['elements'] = $schema_styles_elements;1011 1012		foreach ( $valid_block_names as $block ) {1013			// Build the schema for each block style variation.1014			$style_variation_names = array();1015			if (1016				! empty( $input['styles']['blocks'][ $block ]['variations'] ) &&1017				is_array( $input['styles']['blocks'][ $block ]['variations'] ) &&1018				isset( $valid_variations[ $block ] )1019			) {

Changelog

Introduced in 5.8.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 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.