WP_Theme_JSON::get_blocks_metadata(): array

Description

{
 'core/paragraph': {
 'selector': 'p',
 'elements': {
 'link' => 'link selector',
 'etc' => 'element selector'
 }
 },
 'core/heading': {
 'selector': 'h1',
 'elements': {}
 },
 'core/image': {
 'selector': '.wp-block-image',
 'duotone': 'img',
 'elements': {}
 }
}

Compatibility

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

Return value

array

Block metadata.

Performance profile

How much work a call to WP_Theme_JSON::get_blocks_metadata() 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 how much data it finds.

Instructions

21–26

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

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::get_blocks_metadata() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• wp_get_block_css_selector()Determines the CSS selector for the block type and property provided, returning it if available.
• WP_Block_Type_Registry::get_instance()Utility method to retrieve the main instance of the class.
• WP_Block_Styles_Registry::get_instance()Utility method to retrieve the main instance of the class.
• static::get_block_style_variation_selector()
• static::get_block_selectors()
• static::get_block_element_selectors()
• static::scope_selector()

Source code

View on Trac ↗View on GitHub ↗

1147	protected static function get_blocks_metadata() {1148		$registry       = WP_Block_Type_Registry::get_instance();1149		$blocks         = $registry->get_all_registered();1150		$style_registry = WP_Block_Styles_Registry::get_instance();1151 1152		// Is there metadata for all currently registered blocks?1153		$blocks = array_diff_key( $blocks, static::$blocks_metadata );1154		if ( empty( $blocks ) ) {1155			/*1156			 * New block styles may have been registered within WP_Block_Styles_Registry.1157			 * Update block metadata for any new block style variations.1158			 */1159			$registered_styles = $style_registry->get_all_registered();1160			foreach ( static::$blocks_metadata as $block_name => $block_metadata ) {1161				if ( ! empty( $registered_styles[ $block_name ] ) ) {1162					$style_selectors = $block_metadata['styleVariations'] ?? array();1163 1164					foreach ( $registered_styles[ $block_name ] as $block_style ) {1165						if ( ! isset( $style_selectors[ $block_style['name'] ] ) ) {1166							$style_selectors[ $block_style['name'] ] = static::get_block_style_variation_selector( $block_style['name'], $block_metadata['selector'] );1167						}1168					}1169 1170					static::$blocks_metadata[ $block_name ]['styleVariations'] = $style_selectors;1171				}1172			}1173			return static::$blocks_metadata;1174		}1175 1176		foreach ( $blocks as $block_name => $block_type ) {1177			$root_selector = wp_get_block_css_selector( $block_type );1178 1179			static::$blocks_metadata[ $block_name ]['selector']  = $root_selector;1180			static::$blocks_metadata[ $block_name ]['selectors'] = static::get_block_selectors( $block_type, $root_selector );1181 1182			$elements = static::get_block_element_selectors( $root_selector );1183			if ( ! empty( $elements ) ) {1184				static::$blocks_metadata[ $block_name ]['elements'] = $elements;1185			}1186 1187			// The block may or may not have a duotone selector.1188			$duotone_selector = wp_get_block_css_selector( $block_type, 'filter.duotone' );1189 1190			// Keep backwards compatibility for support.color.__experimentalDuotone.1191			if ( null === $duotone_selector ) {1192				$duotone_support = isset( $block_type->supports['color']['__experimentalDuotone'] )1193					? $block_type->supports['color']['__experimentalDuotone']1194					: null;1195 1196				if ( $duotone_support ) {1197					$root_selector    = wp_get_block_css_selector( $block_type );1198					$duotone_selector = static::scope_selector( $root_selector, $duotone_support );1199				}1200			}1201 1202			if ( null !== $duotone_selector ) {1203				static::$blocks_metadata[ $block_name ]['duotone'] = $duotone_selector;1204			}1205 1206			// If the block has style variations, append their selectors to the block metadata.1207			$style_selectors = array();1208			if ( ! empty( $block_type->styles ) ) {1209				foreach ( $block_type->styles as $style ) {1210					$style_selectors[ $style['name'] ] = static::get_block_style_variation_selector( $style['name'], static::$blocks_metadata[ $block_name ]['selector'] );1211				}1212			}1213 1214			// Block style variations can be registered through the WP_Block_Styles_Registry as well as block.json.1215			$registered_styles = $style_registry->get_registered_styles_for_block( $block_name );1216			foreach ( $registered_styles as $style ) {1217				$style_selectors[ $style['name'] ] = static::get_block_style_variation_selector( $style['name'], static::$blocks_metadata[ $block_name ]['selector'] );1218			}1219 1220			if ( ! empty( $style_selectors ) ) {1221				static::$blocks_metadata[ $block_name ]['styleVariations'] = $style_selectors;1222			}1223		}1224 1225		return static::$blocks_metadata;1226	}

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 6.8.8 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.