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.7 to 7.1.0), 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–75

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

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 · 5

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

Source code

View on Trac ↗View on GitHub ↗

1276	protected static function sanitize( $input, $valid_block_names, $valid_element_names, $valid_variations ) {1277		$output = array();1278 1279		if ( ! is_array( $input ) ) {1280			return $output;1281		}1282 1283		// Preserve only the top most level keys.1284		$output = array_intersect_key( $input, array_flip( static::VALID_TOP_LEVEL_KEYS ) );1285 1286		/*1287		 * Remove any rules that are annotated as "top" in VALID_STYLES constant.1288		 * Some styles are only meant to be available at the top-level (e.g.: blockGap),1289		 * hence, the schema for blocks & elements should not have them.1290		 */1291		$styles_non_top_level = static::VALID_STYLES;1292		foreach ( array_keys( $styles_non_top_level ) as $section ) {1293			// array_key_exists() needs to be used instead of isset() because the value can be null.1294			if ( array_key_exists( $section, $styles_non_top_level ) && is_array( $styles_non_top_level[ $section ] ) ) {1295				foreach ( array_keys( $styles_non_top_level[ $section ] ) as $prop ) {1296					if ( 'top' === $styles_non_top_level[ $section ][ $prop ] ) {1297						unset( $styles_non_top_level[ $section ][ $prop ] );1298					}1299				}1300			}1301		}1302 1303		// Build the schema based on valid block & element names.1304		$schema                   = array();1305		$schema_styles_elements   = array();1306		$responsive_media_queries = static::get_viewport_media_queries( $input['settings']['viewport'] ?? null );1307 1308		/*1309		 * Set allowed element pseudo selectors and responsive breakpoint states.1310		 * Target data structure in schema:1311		 * e.g.1312		 * - top level elements: `$schema['styles']['elements']['link'][':hover']`.1313		 * - block level elements: `$schema['styles']['blocks']['core/button']['elements']['link'][':hover']`.1314		 * - block responsive elements: `$schema['styles']['blocks']['core/button']['@tablet']['elements']['link'][':hover']`.1315		 */1316		foreach ( $valid_element_names as $element ) {1317			$schema_styles_elements[ $element ] = $styles_non_top_level;1318 1319			if ( isset( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $element ] ) ) {1320				foreach ( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $element ] as $pseudo_selector ) {1321					$schema_styles_elements[ $element ][ $pseudo_selector ] = $styles_non_top_level;1322				}1323			}1324 1325			// Add responsive breakpoint states for elements.1326			foreach ( array_keys( $responsive_media_queries ) as $breakpoint_state ) {1327				$schema_styles_elements[ $element ][ $breakpoint_state ] = $styles_non_top_level;1328			}1329		}1330 1331		$schema_styles_blocks   = array();1332		$schema_settings_blocks = array();1333 1334		/*1335		 * Generate a schema for blocks.1336		 * - Block styles can contain `elements`, `variations`, and responsive breakpoint state definitions.1337		 * - Variations definitions cannot be nested.1338		 * - Variations can contain styles for inner `blocks`, `elements`, and responsive breakpoint states.1339		 * - Variation inner `blocks` styles can contain `elements` and responsive breakpoint states.1340		 *1341		 * As each variation needs both a `blocks` schema and responsive `blocks` schemas1342		 * for further nested inner `blocks`, the overall schema is generated in multiple passes.1343		 */1344		foreach ( $valid_block_names as $block ) {1345			$schema_settings_blocks[ $block ] = static::VALID_SETTINGS;1346			// `viewport` and `blockVisibility` are global-only settings and cannot be set per block for now.1347			unset( $schema_settings_blocks[ $block ]['viewport'] );1348			unset( $schema_settings_blocks[ $block ]['blockVisibility'] );1349			$schema_styles_blocks[ $block ]             = $styles_non_top_level;1350			$schema_styles_blocks[ $block ]['elements'] = $schema_styles_elements;1351 1352			// Add responsive breakpoint states for all blocks.1353			foreach ( array_keys( $responsive_media_queries ) as $breakpoint_state ) {1354				$schema_styles_blocks[ $block ][ $breakpoint_state ]             = $styles_non_top_level;1355				$schema_styles_blocks[ $block ][ $breakpoint_state ]['elements'] = $schema_styles_elements;

Changelog

Introduced in 5.8.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 7.1.0 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.